{
"basePath": "/social",
"definitions": {
"A DTO object for resetting user stat items": {
"properties": {
"additionalData": {
"additionalProperties": {
"type": "object"
},
"description": "additional data to be published in event payload",
"type": "object"
},
"statCode": {
"description": "stat code",
"type": "string"
}
},
"required": [
"statCode"
],
"type": "object"
},
"A DTO object for user stat item value": {
"properties": {
"profileId": {
"description": "profile id",
"type": "string"
},
"statCode": {
"description": "stat code",
"type": "string"
},
"value": {
"description": "current value",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"Attribute": {
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
},
"type": "object"
},
"BulkCycleStatsAdd": {
"properties": {
"statCodes": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"statCodes"
],
"type": "object"
},
"BulkStatCycleOperationResult": {
"properties": {
"cycleId": {
"type": "string"
},
"details": {
"type": "object"
},
"statCode": {
"type": "string"
},
"success": {
"type": "boolean"
}
},
"type": "object"
},
"BulkStatCycleRequest": {
"properties": {
"cycleIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"required": [
"cycleIds"
],
"type": "object"
},
"BulkStatCycleResult": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/StatCycleInfo"
},
"type": "array"
}
},
"required": [
"data"
],
"type": "object"
},
"BulkStatItemCreate": {
"properties": {
"statCode": {
"type": "string"
}
},
"required": [
"statCode"
],
"type": "object"
},
"BulkStatItemInc": {
"properties": {
"inc": {
"format": "double",
"type": "number"
},
"statCode": {
"type": "string"
}
},
"required": [
"statCode"
],
"type": "object"
},
"BulkStatItemReset": {
"properties": {
"statCode": {
"type": "string"
}
},
"required": [
"statCode"
],
"type": "object"
},
"BulkStatItemUpdate": {
"properties": {
"additionalData": {
"additionalProperties": {
"type": "object"
},
"description": "Additional data to be published in event payload",
"type": "object"
},
"requestId": {
"type": "string"
},
"statCode": {
"type": "string"
},
"updateStrategy": {
"enum": [
"INCREMENT",
"MAX",
"MIN",
"OVERRIDE"
],
"type": "string"
},
"value": {
"format": "double",
"type": "number"
}
},
"required": [
"statCode",
"updateStrategy",
"value"
],
"type": "object"
},
"BulkStatOperationResult": {
"properties": {
"details": {
"type": "object"
},
"requestId": {
"type": "string"
},
"statCode": {
"type": "string"
},
"success": {
"type": "boolean"
},
"userId": {
"type": "string"
}
},
"type": "object"
},
"BulkUserStatItemByStatCodes": {
"properties": {
"statCodes": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
}
},
"type": "object"
},
"BulkUserStatItemInc": {
"properties": {
"inc": {
"format": "double",
"type": "number"
},
"statCode": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"statCode",
"userId"
],
"type": "object"
},
"BulkUserStatItemReset": {
"properties": {
"statCode": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"required": [
"statCode",
"userId"
],
"type": "object"
},
"BulkUserStatItemUpdate": {
"properties": {
"additionalData": {
"additionalProperties": {
"type": "object"
},
"description": "Additional data to be published in event payload",
"type": "object"
},
"additionalKey": {
"description": "Additional key to identify multi level user's statitems, e.g. character's statitems",
"type": "string"
},
"requestId": {
"type": "string"
},
"statCode": {
"type": "string"
},
"updateStrategy": {
"enum": [
"INCREMENT",
"MAX",
"MIN",
"OVERRIDE"
],
"type": "string"
},
"userId": {
"type": "string"
},
"value": {
"format": "double",
"type": "number"
}
},
"required": [
"statCode",
"updateStrategy",
"userId",
"value"
],
"type": "object"
},
"CycleOverride": {
"properties": {
"cycleId": {
"type": "string"
},
"maximum": {
"format": "double",
"type": "number"
},
"minimum": {
"format": "double",
"type": "number"
}
},
"type": "object"
},
"CycleOverrideRequest": {
"properties": {
"cycleId": {
"type": "string"
},
"maximum": {
"format": "double",
"type": "number"
},
"minimum": {
"format": "double",
"type": "number"
}
},
"required": [
"cycleId"
],
"type": "object"
},
"ErrorEntity": {
"properties": {
"devStackTrace": {
"description": "internal server error stack trace in configured environment",
"type": "string"
},
"errorCode": {
"description": "numeric error code",
"format": "int32",
"type": "integer"
},
"errorMessage": {
"description": "error message",
"type": "string"
},
"messageVariables": {
"additionalProperties": {
"type": "string"
},
"description": "message variables",
"type": "object"
},
"requiredPermission": {
"$ref": "#/definitions/Permission"
}
},
"required": [
"errorCode",
"errorMessage"
],
"type": "object"
},
"FieldValidationError": {
"properties": {
"errorCode": {
"type": "string"
},
"errorField": {
"type": "string"
},
"errorMessage": {
"type": "string"
},
"errorValue": {
"type": "string"
},
"messageVariables": {
"additionalProperties": {
"type": "string"
},
"type": "object"
}
},
"type": "object"
},
"GameProfileHeader": {
"properties": {
"avatarUrl": {
"type": "string"
},
"label": {
"type": "string"
},
"namespace": {
"type": "string"
},
"profileId": {
"type": "string"
},
"profileName": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"userId": {
"type": "string"
}
},
"type": "object"
},
"GameProfileInfo": {
"properties": {
"achievements": {
"items": {
"type": "string"
},
"type": "array"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"avatarUrl": {
"type": "string"
},
"inventories": {
"items": {
"type": "string"
},
"type": "array"
},
"label": {
"type": "string"
},
"namespace": {
"type": "string"
},
"profileId": {
"type": "string"
},
"profileName": {
"type": "string"
},
"statistics": {
"items": {
"type": "string"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"userId": {
"type": "string"
}
},
"type": "object"
},
"GameProfilePublicInfo": {
"properties": {
"avatarUrl": {
"type": "string"
},
"namespace": {
"type": "string"
},
"profileId": {
"type": "string"
},
"profileName": {
"type": "string"
}
},
"type": "object"
},
"GameProfileRequest": {
"properties": {
"achievements": {
"items": {
"type": "string"
},
"type": "array"
},
"attributes": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"avatarUrl": {
"type": "string"
},
"inventories": {
"items": {
"type": "string"
},
"type": "array"
},
"label": {
"type": "string"
},
"profileName": {
"type": "string"
},
"statistics": {
"items": {
"type": "string"
},
"type": "array"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GlobalStatItemInfo": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"globalAggregationMethod": {
"enum": [
"LAST",
"MAX",
"MIN",
"TOTAL"
],
"type": "string"
},
"namespace": {
"type": "string"
},
"statCode": {
"type": "string"
},
"statName": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"updatedAt": {
"format": "date-time",
"type": "string"
},
"value": {
"format": "double",
"type": "number"
}
},
"required": [
"createdAt",
"namespace",
"statCode",
"statName",
"updatedAt",
"value"
],
"type": "object"
},
"GlobalStatItemPagingSlicedResult": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/GlobalStatItemInfo"
},
"type": "array"
},
"paging": {
"$ref": "#/definitions/Paging"
}
},
"required": [
"data"
],
"type": "object"
},
"NamespaceSlotConfigInfo": {
"properties": {
"maxSlotSize": {
"format": "int32",
"type": "integer"
},
"maxSlots": {
"format": "int32",
"type": "integer"
},
"namespace": {
"type": "string"
}
},
"type": "object"
},
"Paging": {
"properties": {
"next": {
"type": "string"
},
"previous": {
"type": "string"
}
},
"type": "object"
},
"Permission": {
"properties": {
"action": {
"format": "int32",
"type": "integer"
},
"resource": {
"type": "string"
}
},
"type": "object"
},
"SlotConfigUpdate": {
"properties": {
"maxSlotSize": {
"format": "int32",
"type": "integer"
},
"maxSlots": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"SlotInfo": {
"properties": {
"checksum": {
"description": "base64 encoded md5",
"type": "string"
},
"customAttribute": {
"type": "string"
},
"dateAccessed": {
"format": "date-time",
"type": "string"
},
"dateCreated": {
"format": "date-time",
"type": "string"
},
"dateModified": {
"format": "date-time",
"type": "string"
},
"label": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"namespace": {
"type": "string"
},
"originalName": {
"type": "string"
},
"size": {
"format": "int64",
"type": "integer"
},
"slotId": {
"type": "string"
},
"storedName": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
},
"userId": {
"type": "string"
}
},
"type": "object"
},
"SlotMetadataUpdate": {
"properties": {
"customAttribute": {
"type": "string"
},
"label": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"StatCreate": {
"properties": {
"capCycleOverride": {
"description": "The field used to define cap behavior of stat cycle min/max override.\nIf set to false, all stat cycle and stat item will continue as is if one stat cycle is capped on its min/max.\nIf set to true, all stat cycle and stat item cannot continue if one of stat cycle is capped on its min/max",
"type": "boolean"
},
"cycleIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cycleOverrides": {
"items": {
"$ref": "#/definitions/CycleOverrideRequest"
},
"type": "array",
"uniqueItems": true
},
"defaultValue": {
"format": "double",
"type": "number"
},
"description": {
"type": "string"
},
"globalAggregationMethod": {
"description": "The aggregation method for global stat, default TOTAL",
"enum": [
"LAST",
"MAX",
"MIN",
"TOTAL"
],
"type": "string"
},
"ignoreAdditionalDataOnValueRejected": {
"type": "boolean"
},
"incrementOnly": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"maximum": {
"description": "default value is 1.7976931348623157e+308",
"format": "double",
"type": "number"
},
"minimum": {
"description": "default value is 0.0",
"format": "double",
"type": "number"
},
"name": {
"type": "string"
},
"setAsGlobal": {
"type": "boolean"
},
"setBy": {
"enum": [
"CLIENT",
"SERVER"
],
"type": "string"
},
"statCode": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"visibility": {
"description": "The visibility for a stat, the default SHOWALL",
"enum": [
"SERVERONLY",
"SHOWALL"
],
"type": "string"
}
},
"required": [
"defaultValue",
"name",
"setBy",
"statCode"
],
"type": "object"
},
"StatCycleCreate": {
"properties": {
"cycleType": {
"description": "Cycle Type",
"enum": [
"ANNUALLY",
"DAILY",
"MONTHLY",
"SEASONAL",
"WEEKLY"
],
"type": "string"
},
"description": {
"type": "string"
},
"end": {
"description": "end date time",
"format": "date-time",
"type": "string"
},
"id": {
"description": "cycle id",
"type": "string"
},
"name": {
"type": "string"
},
"resetDate": {
"description": "reset date",
"format": "int32",
"type": "integer"
},
"resetDay": {
"description": "reset day of week",
"format": "int32",
"type": "integer"
},
"resetMonth": {
"description": "reset month",
"format": "int32",
"type": "integer"
},
"resetTime": {
"type": "string"
},
"seasonPeriod": {
"description": "season period",
"format": "int32",
"type": "integer"
},
"start": {
"description": "start date time",
"format": "date-time",
"type": "string"
}
},
"required": [
"cycleType",
"name",
"resetTime",
"start"
],
"type": "object"
},
"StatCycleInfo": {
"properties": {
"createdAt": {
"format": "date-time",
"type": "string"
},
"currentVersion": {
"format": "int32",
"type": "integer"
},
"cycleType": {
"enum": [
"ANNUALLY",
"DAILY",
"MONTHLY",
"SEASONAL",
"WEEKLY"
],
"type": "string"
},
"description": {
"type": "string"
},
"end": {
"format": "date-time",
"type": "string"
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"nextReset": {
"format": "date-time",
"type": "string"
},
"resetDate": {
"format": "int32",
"type": "integer"
},
"resetDay": {
"format": "int32",
"type": "integer"
},
"resetMonth": {
"format": "int32",
"type": "integer"
},
"resetTime": {
"type": "string"
},
"seasonPeriod": {
"format": "int32",
"type": "integer"
},
"start": {
"format": "date-time",
"type": "string"
},
"status": {
"enum": [
"ACTIVE",
"INIT",
"STOPPED"
],
"type": "string"
},
"updatedAt": {
"format": "date-time",
"type": "string"
}
},
"required": [
"createdAt",
"currentVersion",
"cycleType",
"id",
"name",
"namespace",
"resetTime",
"start",
"status",
"updatedAt"
],
"type": "object"
},
"StatCyclePagingSlicedResult": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/StatCycleInfo"
},
"type": "array"
},
"paging": {
"$ref": "#/definitions/Paging"
}
},
"required": [
"data"
],
"type": "object"
},
"StatCycleUpdate": {
"properties": {
"cycleType": {
"description": "Cycle Type",
"enum": [
"ANNUALLY",
"DAILY",
"MONTHLY",
"SEASONAL",
"WEEKLY"
],
"type": "string"
},
"description": {
"type": "string"
},
"end": {
"description": "end date time",
"format": "date-time",
"type": "string"
},
"name": {
"type": "string"
},
"resetDate": {
"description": "reset date",
"format": "int32",
"type": "integer"
},
"resetDay": {
"description": "reset day of week",
"format": "int32",
"type": "integer"
},
"resetMonth": {
"description": "reset month",
"format": "int32",
"type": "integer"
},
"resetTime": {
"type": "string"
},
"seasonPeriod": {
"description": "season period",
"format": "int32",
"type": "integer"
},
"start": {
"description": "start date time",
"format": "date-time",
"type": "string"
}
},
"required": [
"cycleType",
"name",
"resetTime",
"start"
],
"type": "object"
},
"StatImportInfo": {
"properties": {
"failedConfigs": {
"items": {
"type": "string"
},
"type": "array"
},
"ignoredConfigs": {
"items": {
"type": "string"
},
"type": "array"
},
"newConfigs": {
"items": {
"type": "string"
},
"type": "array"
},
"replacedConfigs": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"failedConfigs",
"ignoredConfigs",
"newConfigs",
"replacedConfigs"
],
"type": "object"
},
"StatInfo": {
"properties": {
"capCycleOverride": {
"type": "boolean"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"cycleIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cycleOverrides": {
"items": {
"$ref": "#/definitions/CycleOverride"
},
"type": "array",
"uniqueItems": true
},
"defaultValue": {
"format": "double",
"type": "number"
},
"description": {
"type": "string"
},
"globalAggregationMethod": {
"enum": [
"LAST",
"MAX",
"MIN",
"TOTAL"
],
"type": "string"
},
"ignoreAdditionalDataOnValueRejected": {
"type": "boolean"
},
"incrementOnly": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"maximum": {
"format": "double",
"type": "number"
},
"minimum": {
"format": "double",
"type": "number"
},
"name": {
"type": "string"
},
"namespace": {
"type": "string"
},
"setAsGlobal": {
"type": "boolean"
},
"setBy": {
"enum": [
"CLIENT",
"SERVER"
],
"type": "string"
},
"statCode": {
"type": "string"
},
"status": {
"enum": [
"INIT",
"TIED"
],
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"updatedAt": {
"format": "date-time",
"type": "string"
},
"visibility": {
"enum": [
"SERVERONLY",
"SHOWALL"
],
"type": "string"
}
},
"required": [
"createdAt",
"defaultValue",
"ignoreAdditionalDataOnValueRejected",
"incrementOnly",
"isPublic",
"name",
"namespace",
"setAsGlobal",
"setBy",
"statCode",
"status",
"updatedAt"
],
"type": "object"
},
"StatItemInc": {
"properties": {
"inc": {
"format": "double",
"type": "number"
}
},
"type": "object"
},
"StatItemIncResult": {
"properties": {
"currentValue": {
"format": "double",
"type": "number"
}
},
"required": [
"currentValue"
],
"type": "object"
},
"StatItemUpdate": {
"properties": {
"additionalData": {
"additionalProperties": {
"type": "object"
},
"description": "Additional data to be published in event payload",
"type": "object"
},
"updateStrategy": {
"enum": [
"INCREMENT",
"MAX",
"MIN",
"OVERRIDE"
],
"type": "string"
},
"value": {
"format": "double",
"type": "number"
}
},
"required": [
"updateStrategy",
"value"
],
"type": "object"
},
"StatItemValue": {
"properties": {
"createdAt": {
"description": "created at",
"format": "date-time",
"type": "string"
},
"updatedAt": {
"description": "updated at",
"format": "date-time",
"type": "string"
},
"userId": {
"description": "user id",
"type": "string"
},
"value": {
"description": "current value",
"format": "double",
"type": "number"
}
},
"type": "object"
},
"StatItemValuePagingSlicedResult": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/StatItemValue"
},
"type": "array"
},
"paging": {
"$ref": "#/definitions/Paging"
}
},
"required": [
"data"
],
"type": "object"
},
"StatPagingSlicedResult": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/StatInfo"
},
"type": "array"
},
"paging": {
"$ref": "#/definitions/Paging"
}
},
"required": [
"data"
],
"type": "object"
},
"StatResetInfo": {
"properties": {
"additionalData": {
"additionalProperties": {
"type": "object"
},
"description": "Additional data to be published in event payload",
"type": "object"
}
},
"type": "object"
},
"StatUpdate": {
"properties": {
"capCycleOverride": {
"description": "The field used to define cap behavior of stat cycle min/max override.\nIf set to false, all stat cycle and stat item will continue as is if one stat cycle is capped on its min/max.\nIf set to true, all stat cycle and stat item cannot continue if one of stat cycle is capped on its min/max",
"type": "boolean"
},
"cycleIds": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"cycleOverrides": {
"items": {
"$ref": "#/definitions/CycleOverrideRequest"
},
"type": "array",
"uniqueItems": true
},
"defaultValue": {
"format": "double",
"type": "number"
},
"description": {
"type": "string"
},
"globalAggregationMethod": {
"enum": [
"LAST",
"MAX",
"MIN",
"TOTAL"
],
"type": "string"
},
"ignoreAdditionalDataOnValueRejected": {
"type": "boolean"
},
"incrementOnly": {
"type": "boolean"
},
"isPublic": {
"type": "boolean"
},
"maximum": {
"format": "double",
"type": "number"
},
"minimum": {
"format": "double",
"type": "number"
},
"name": {
"type": "string"
},
"setAsGlobal": {
"type": "boolean"
},
"setBy": {
"enum": [
"CLIENT",
"SERVER"
],
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"visibility": {
"enum": [
"SERVERONLY",
"SHOWALL"
],
"type": "string"
}
},
"type": "object"
},
"UserGameProfiles": {
"properties": {
"gameProfiles": {
"items": {
"$ref": "#/definitions/GameProfilePublicInfo"
},
"type": "array"
},
"userId": {
"type": "string"
}
},
"type": "object"
},
"UserSlotConfigInfo": {
"properties": {
"maxSlotSize": {
"format": "int32",
"type": "integer"
},
"maxSlots": {
"format": "int32",
"type": "integer"
},
"namespace": {
"type": "string"
},
"userId": {
"type": "string"
}
},
"type": "object"
},
"UserStatCycleItemInfo": {
"properties": {
"additionalData": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"cycleId": {
"type": "string"
},
"cycleName": {
"type": "string"
},
"cycleVersion": {
"format": "int32",
"type": "integer"
},
"namespace": {
"type": "string"
},
"statCode": {
"type": "string"
},
"statName": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"updatedAt": {
"format": "date-time",
"type": "string"
},
"userId": {
"type": "string"
},
"value": {
"format": "double",
"type": "number"
}
},
"required": [
"createdAt",
"cycleId",
"cycleName",
"cycleVersion",
"namespace",
"statCode",
"statName",
"updatedAt",
"userId",
"value"
],
"type": "object"
},
"UserStatCycleItemPagingSlicedResult": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/UserStatCycleItemInfo"
},
"type": "array"
},
"paging": {
"$ref": "#/definitions/Paging"
}
},
"required": [
"data"
],
"type": "object"
},
"UserStatItemInfo": {
"properties": {
"additionalData": {
"additionalProperties": {
"type": "object"
},
"type": "object"
},
"createdAt": {
"format": "date-time",
"type": "string"
},
"namespace": {
"type": "string"
},
"statCode": {
"type": "string"
},
"statName": {
"type": "string"
},
"tags": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
"updatedAt": {
"format": "date-time",
"type": "string"
},
"userId": {
"type": "string"
},
"value": {
"format": "double",
"type": "number"
}
},
"required": [
"createdAt",
"namespace",
"statCode",
"statName",
"updatedAt",
"userId",
"value"
],
"type": "object"
},
"UserStatItemPagingSlicedResult": {
"properties": {
"data": {
"items": {
"$ref": "#/definitions/UserStatItemInfo"
},
"type": "array"
},
"paging": {
"$ref": "#/definitions/Paging"
}
},
"required": [
"data"
],
"type": "object"
},
"ValidationErrorEntity": {
"properties": {
"errorCode": {
"description": "numeric error code",
"format": "int32",
"type": "integer"
},
"errorMessage": {
"description": "error message",
"type": "string"
},
"errors": {
"items": {
"$ref": "#/definitions/FieldValidationError"
},
"type": "array"
}
},
"required": [
"errorCode",
"errorMessage"
],
"type": "object"
}
},
"externalDocs": {
"description": "API Docs",
"url": "https://stage.accelbyte.io/social"
},
"info": {
"contact": {
"email": "engineering@accelbyte.io",
"name": "Engineering Team at AccelByte",
"url": "https://accelbyte.io"
},
"description": "Justice Statistics Service",
"title": "justice-statistics-service",
"version": "4.5.2"
},
"paths": {
"/admin/namespaces/{namespace}/config": {
"delete": {
"deprecated": true,
"description": "
The endpoint is going to be deprecated
Deletes a namespace slot configuration, the configuration will be default after delete.
Other detail info:",
"operationId": "deleteNamespaceSlotConfig",
"parameters": [
{
"description": "Namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Successful delete of namespace slot config"
}
},
"security": [
{
"authorization": []
}
],
"summary": "Deletes a namespace slot configuration",
"tags": [
"SlotConfig"
],
"x-operationId": {
"value": "social/admin/slot-definitions/v1/delete"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:SLOTCONFIG [DELETE]"
},
"x-errorCodes": {}
},
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Get slot configuration for a given namespace. In case slot configuration is not set, the default will be returned.
Other detail info:- Returns: namespace slot config info
",
"operationId": "getNamespaceSlotConfig",
"parameters": [
{
"description": "Namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/NamespaceSlotConfigInfo"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns a namespace slot configuration",
"tags": [
"SlotConfig"
],
"x-operationId": {
"value": "social/admin/slot-definitions/v1/get"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:SLOTCONFIG [READ]"
},
"x-errorCodes": {}
},
"put": {
"consumes": [
"application/json"
],
"deprecated": true,
"description": "The endpoint is going to be deprecated
Update a slot namespace configuration.
Other detail info:- Returns: updated namespace slot config
",
"operationId": "updateNamespaceSlotConfig",
"parameters": [
{
"description": "Namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/SlotConfigUpdate"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/NamespaceSlotConfigInfo"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Update a namespace slot configuration",
"tags": [
"SlotConfig"
],
"x-operationId": {
"value": "social/admin/slot-definitions/v1/update"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:SLOTCONFIG [UPDATE]"
},
"x-errorCodes": {}
}
},
"/admin/namespaces/{namespace}/users/{userId}/config": {
"delete": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Deletes a user slot configuration in given namespace, the namespace slot configuration will be returned after delete.
Other detail info:",
"operationId": "deleteUserSlotConfig",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Successful delete of user/namespace slot config"
}
},
"security": [
{
"authorization": []
}
],
"summary": "Deletes a user slot configuration",
"tags": [
"SlotConfig"
],
"x-operationId": {
"value": "social/admin/slot-definitions/v1/delete-user"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:SLOTCONFIG [DELETE]"
},
"x-errorCodes": {}
},
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Get a user slot configuration in given namespace. In case the user slot configuration is not set, the namespace configuration will be returned.
Other detail info:- Returns: slot config info
",
"operationId": "getUserSlotConfig",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserSlotConfigInfo"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns a user slot configuration",
"tags": [
"SlotConfig"
],
"x-operationId": {
"value": "social/admin/slot-definitions/v1/get-user"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:SLOTCONFIG [READ]"
},
"x-errorCodes": {}
},
"put": {
"consumes": [
"application/json"
],
"deprecated": true,
"description": "The endpoint is going to be deprecated
Update a user slot configuration in given namespace.
Other detail info:- Returns: updated slot config
",
"operationId": "updateUserSlotConfig",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/SlotConfigUpdate"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserSlotConfigInfo"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Update a user slot configuration",
"tags": [
"SlotConfig"
],
"x-operationId": {
"value": "social/admin/slot-definitions/v1/update-user"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:SLOTCONFIG [UPDATE]"
},
"x-errorCodes": {}
}
},
"/admin/namespaces/{namespace}/users/{userId}/profiles": {
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Returns all profiles' header for a user.
Other detail info:- Returns: list of profiles
",
"operationId": "getUserProfiles",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/GameProfileHeader"
},
"type": "array"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns all profiles' header for a user",
"tags": [
"GameProfile"
],
"x-operationId": {
"value": "social/admin/profiles/v1/list"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:GAMEPROFILE [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/admin/namespaces/{namespace}/users/{userId}/profiles/{profileId}": {
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Returns profile for a user.
Other detail info:- Returns: game profile info
",
"operationId": "getProfile",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Game profile ID",
"in": "path",
"name": "profileId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GameProfileInfo"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12041 | Game profile with id [{profileId}] is not found |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns profile for a user",
"tags": [
"GameProfile"
],
"x-operationId": {
"value": "social/admin/profiles/v1/get"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:GAMEPROFILE [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12041": "Game profile with id [{profileId}] is not found",
"20000": "Internal server error"
}
}
},
"/admin/namespaces/{namespace}/users/{userId}/slots": {
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Get slots for a given user.
Other detail info:",
"operationId": "getUserNamespaceSlots",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/SlotInfo"
},
"type": "array"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns list of slots for given user",
"tags": [
"Slot"
],
"x-operationId": {
"value": "social/admin/slots/v1/list"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:SLOTDATA [READ]"
},
"x-errorCodes": {}
}
},
"/admin/namespaces/{namespace}/users/{userId}/slots/{slotId}": {
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Get slot data.
Other detail info:",
"operationId": "getSlotData",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Slot ID",
"in": "path",
"name": "slotId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/octet-stream"
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"type": "string",
"format": "binary"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12141 | Slot [{slotId}] not found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns slot data",
"tags": [
"Slot"
],
"x-operationId": {
"value": "social/admin/slots/v1/get"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:SLOTDATA [READ]"
},
"x-errorCodes": {
"12141": "Slot [{slotId}] not found in namespace [{namespace}]"
}
}
},
"/public/namespaces/{namespace}/profiles": {
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Returns all profiles for specified users.
Other detail info:- Returns: list of profiles
",
"operationId": "publicGetUserGameProfiles",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "User IDs",
"in": "query",
"items": {
"type": "string"
},
"name": "userIds",
"required": true,
"type": "array"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/UserGameProfiles"
},
"type": "array"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12021 | {totalUser} users is requested. Cannot retrieve more than {limitUser} users at once |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns all profiles for specified users",
"tags": [
"GameProfile"
],
"x-operationId": {
"value": "social/public/profiles/v1/list-user"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:GAMEPROFILE [READ]"
},
"x-errorCodes": {
"12021": "{totalUser} users is requested. Cannot retrieve more than {limitUser} users at once",
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/public/namespaces/{namespace}/users/{userId}/profiles": {
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Returns all profiles' header for a user.
Other detail info:- Returns: list of profiles
",
"operationId": "publicGetUserProfiles",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/GameProfileHeader"
},
"type": "array"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns all profiles' header for a user",
"tags": [
"GameProfile"
],
"x-operationId": {
"value": "social/public/profiles/v1/list"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:GAMEPROFILE [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
},
"post": {
"consumes": [
"application/json"
],
"deprecated": true,
"description": "The endpoint is going to be deprecated
Create new profile for user.
Other detail info:- Returns
: created game profile
",
"operationId": "publicCreateProfile",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/GameProfileRequest"
}
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Profile has been created"
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Create a new profile for user",
"tags": [
"GameProfile"
],
"x-operationId": {
"value": "social/public/profiles/v1/create"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:GAMEPROFILE [CREATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/public/namespaces/{namespace}/users/{userId}/profiles/{profileId}": {
"delete": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Deletes game profile.
",
"operationId": "publicDeleteProfile",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Game profile ID",
"in": "path",
"name": "profileId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Game profile has been deleted"
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12041 | Game profile with id [{profileId}] is not found |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Deletes game profile",
"tags": [
"GameProfile"
],
"x-operationId": {
"value": "social/public/profiles/v1/delete"
},
"x-security": {
"action": "8",
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:GAMEPROFILE [DELETE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12041": "Game profile with id [{profileId}] is not found",
"20000": "Internal server error"
}
},
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Returns profile for a user.
Other detail info:- Returns: game profile info
",
"operationId": "publicGetProfile",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Game profile ID",
"in": "path",
"name": "profileId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GameProfileInfo"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12041 | Game profile with id [{profileId}] is not found |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns profile for a user",
"tags": [
"GameProfile"
],
"x-operationId": {
"value": "social/public/profiles/v1/get"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:GAMEPROFILE [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12041": "Game profile with id [{profileId}] is not found",
"20000": "Internal server error"
}
},
"put": {
"consumes": [
"application/json"
],
"deprecated": true,
"description": "The endpoint is going to be deprecated
Updates user game profile, returns updated profile.
Other detail info:- Returns: updated game profile
",
"operationId": "publicUpdateProfile",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Game profile ID",
"in": "path",
"name": "profileId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/GameProfileRequest"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GameProfileInfo"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12041 | Game profile with id [{profileId}] is not found |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Updates user game profile",
"tags": [
"GameProfile"
],
"x-operationId": {
"value": "social/public/profiles/v1/update"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:GAMEPROFILE [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12041": "Game profile with id [{profileId}] is not found",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/public/namespaces/{namespace}/users/{userId}/profiles/{profileId}/attributes/{attributeName}": {
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Returns game profile attribute.
Other detail info:",
"operationId": "publicGetProfileAttribute",
"parameters": [
{
"description": "Attribute Name",
"in": "path",
"name": "attributeName",
"required": true,
"type": "string"
},
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Game profile ID",
"in": "path",
"name": "profileId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/Attribute"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12041 | Game profile with id [{profileId}] is not found |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns game profile attribute",
"tags": [
"GameProfile"
],
"x-operationId": {
"value": "social/public/profiles/v1/get-attribute"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:GAMEPROFILE [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12041": "Game profile with id [{profileId}] is not found",
"20000": "Internal server error"
}
},
"put": {
"consumes": [
"application/json"
],
"deprecated": true,
"description": "The endpoint is going to be deprecated
Updates game profile attribute, returns updated profile.
Other detail info:- Returns: updated attribute
",
"operationId": "publicUpdateAttribute",
"parameters": [
{
"description": "Attribute Name",
"in": "path",
"name": "attributeName",
"required": true,
"type": "string"
},
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Game profile ID",
"in": "path",
"name": "profileId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/Attribute"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GameProfileInfo"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12022 | Game profile attribute name [{attrName1}] passed in request url mismatch the name [{attrName2}] in body |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12041 | Game profile with id [{profileId}] is not found |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Updates game profile attribute",
"tags": [
"GameProfile"
],
"x-operationId": {
"value": "social/public/profiles/v1/update-attribute"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:GAMEPROFILE [DELETE]"
},
"x-errorCodes": {
"12022": "Game profile attribute name [{attrName1}] passed in request url mismatch the name [{attrName2}] in body",
"20001": "Unauthorized",
"20013": "insufficient permission",
"12041": "Game profile with id [{profileId}] is not found",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/public/namespaces/{namespace}/users/{userId}/slots": {
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Get list of slots for a given user in namespace.
Other detail info:",
"operationId": "publicGetUserNamespaceSlots",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/SlotInfo"
},
"type": "array"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns slots for given user",
"tags": [
"Slot"
],
"x-operationId": {
"value": "social/public/slots/v1/list"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:SLOTDATA [READ]"
},
"x-errorCodes": {}
},
"post": {
"consumes": [
"multipart/form-data"
],
"deprecated": true,
"description": "The endpoint is going to be deprecated
Creates a slot.
Other detail info:- Returns: created slot info
",
"operationId": "publicCreateUserNamespaceSlot",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "File checksum, base64 encoded md5",
"in": "formData",
"name": "checksum",
"required": false,
"type": "string"
},
{
"description": "Custom attribute",
"in": "formData",
"name": "customAttribute",
"required": false,
"type": "string"
},
{
"in": "formData",
"name": "file",
"required": false,
"type": "file"
},
{
"description": "Label",
"in": "query",
"name": "label",
"required": false,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "Tags",
"in": "query",
"items": {
"type": "string"
},
"name": "tags",
"required": false,
"type": "array"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Successful create of a slot"
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12121 | Checksum mismatch for [{filename}] |
| 12122 | [{filename}] exceeds the upload limit size of [{sizeLimit}] bytes |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12171 | User [{userId}] exceed max slot count [{maxCount}] in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Creates a slot",
"tags": [
"Slot"
],
"x-operationId": {
"value": "social/public/slots/v1/create"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:SLOTDATA [CREATE]"
},
"x-errorCodes": {
"12121": "Checksum mismatch for [{filename}]",
"12122": "[{filename}] exceeds the upload limit size of [{sizeLimit}] bytes",
"12171": "User [{userId}] exceed max slot count [{maxCount}] in namespace [{namespace}]"
}
}
},
"/public/namespaces/{namespace}/users/{userId}/slots/{slotId}": {
"delete": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Deletes the slot.
Other detail info:",
"operationId": "publicDeleteUserNamespaceSlot",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Slot ID",
"in": "path",
"name": "slotId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "Successful delete of a slot"
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12141 | Slot [{slotId}] not found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Deletes the slot",
"tags": [
"Slot"
],
"x-operationId": {
"value": "social/public/slots/v1/delete"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:SLOTDATA [DELETE]"
},
"x-errorCodes": {
"12141": "Slot [{slotId}] not found in namespace [{namespace}]"
}
},
"get": {
"deprecated": true,
"description": "The endpoint is going to be deprecated
Get slot data.
Other detail info:",
"operationId": "publicGetSlotData",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Slot ID",
"in": "path",
"name": "slotId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/octet-stream"
],
"responses": {
"200": {
"description": "Successful operation",
"schema": {
"type": "string",
"format": "binary"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12141 | Slot [{slotId}] not found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Returns slot data",
"tags": [
"Slot"
],
"x-operationId": {
"value": "social/public/slots/v1/get"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:SLOTDATA [READ]"
},
"x-errorCodes": {
"12141": "Slot [{slotId}] not found in namespace [{namespace}]"
}
},
"put": {
"consumes": [
"multipart/form-data"
],
"deprecated": true,
"description": "The endpoint is going to be deprecated
Updates a slot.
Other detail info:",
"operationId": "publicUpdateUserNamespaceSlot",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Slot ID",
"in": "path",
"name": "slotId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "File checksum",
"in": "formData",
"name": "checksum",
"required": false,
"type": "string"
},
{
"description": "Custom attribute",
"in": "formData",
"name": "customAttribute",
"required": false,
"type": "string"
},
{
"in": "formData",
"name": "file",
"required": false,
"type": "file"
},
{
"description": "Label",
"in": "query",
"name": "label",
"required": false,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "Tags",
"in": "query",
"items": {
"type": "string"
},
"name": "tags",
"required": false,
"type": "array"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/SlotInfo"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12121 | Checksum mismatch for [{filename}] |
| 12122 | [{filename}] exceeds the upload limit size of [{sizeLimit}] bytes |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12141 | Slot [{slotId}] not found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Updates a slot",
"tags": [
"Slot"
],
"x-operationId": {
"value": "social/public/slots/v1/update"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:SLOTDATA [UPDATE]"
},
"x-errorCodes": {
"12121": "Checksum mismatch for [{filename}]",
"12122": "[{filename}] exceeds the upload limit size of [{sizeLimit}] bytes",
"12141": "Slot [{slotId}] not found in namespace [{namespace}]"
}
}
},
"/public/namespaces/{namespace}/users/{userId}/slots/{slotId}/metadata": {
"put": {
"consumes": [
"application/json"
],
"deprecated": true,
"description": "The endpoint is going to be deprecated
Updates the slot metadata.
Other detail info:",
"operationId": "publicUpdateUserNamespaceSlotMetadata",
"parameters": [
{
"description": "Namespace ID",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "Slot ID",
"in": "path",
"name": "slotId",
"required": true,
"type": "string"
},
{
"description": "User ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"in": "body",
"name": "body",
"required": false,
"schema": {
"$ref": "#/definitions/SlotMetadataUpdate"
}
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/SlotInfo"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12141 | Slot [{slotId}] not found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Updates the slot metadata",
"tags": [
"Slot"
],
"x-operationId": {
"value": "social/public/slots/v1/update-metadata"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:SLOTDATA [UPDATE]"
},
"x-errorCodes": {
"12141": "Slot [{slotId}] not found in namespace [{namespace}]"
}
}
},
"/v1/admin/namespaces/{namespace}/globalstatitems": {
"get": {
"description": "List global statItems by pagination.
",
"operationId": "getGlobalStatItems",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"description": "comma separated stat codes",
"in": "query",
"name": "statCodes",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GlobalStatItemPagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List global statItems",
"tags": [
"GlobalStatistic"
],
"x-operationId": {
"value": "social/admin/global-stat-values/v1/list"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/globalstatitems/{statCode}": {
"get": {
"description": "Get global statItem by stat code.
Other detail info:- Returns: global stat item
",
"operationId": "getGlobalStatItemByStatCode",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat Code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GlobalStatItemInfo"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12244 | Global stat item of [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Get global statItem by stat code",
"tags": [
"GlobalStatistic"
],
"x-operationId": {
"value": "social/admin/global-stat-values/v1/get"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12244": "Global stat item of [{statCode}] cannot be found in namespace [{namespace}]",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statCycles": {
"get": {
"description": "List stat cycles by pagination.
Other detail info:",
"operationId": "getStatCycles",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"enum": [
"ANNUALLY",
"DAILY",
"MONTHLY",
"SEASONAL",
"WEEKLY"
],
"in": "query",
"name": "cycleType",
"required": false,
"type": "string"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"description": "name",
"in": "query",
"name": "name",
"required": false,
"type": "string"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"description": "default is unsorted, allow values: [start, start:asc, start:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc],and support sort group, eg: sortBy=start:asc,createdAt:desc.",
"in": "query",
"name": "sortBy",
"required": false,
"type": "string"
},
{
"enum": [
"ACTIVE",
"INIT",
"STOPPED"
],
"in": "query",
"name": "status",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatCyclePagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List stat cycles",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/list"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Create stat cycle.
Fields:- id: Cycle id, consist of alphanumeric characters with a maximum of 32 characters. if not provided will be generated. (optional).
- name: Cycle name, maximum length is 128 characters. (required).
- resetTime: Reset time must follow hours:minutes in 24 hours format e.g. 01:30, 23:15. (required)
- resetDay: Reset Day follows the ISO-8601 standard, from 1 (Monday) to 7 (Sunday). Required when cycleType is WEEKLY.
- resetDate: Reset Date must be a number 1 - 31. Required when cycleType is MONTHLY or ANNUALLY.
- resetMonth: Reset Month must be a number 1 - 12. Required when cycleType is ANNUALLY.
- seasonPeriod: Season period must be a number greater than or equal to 1 (days). Required when cycleType is SEASONAL.
- start: Start time must follow RFC3339 standard. e.g. 2023-02-24T05:10:24.865Z. (required)
- end: End time must follow RFC3339 standard. e.g. 2023-02-24T05:10:24.865Z.
Other detail info:- Returns: created stat cycle
",
"operationId": "createStatCycle",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatCycleCreate"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatCycleInfo"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12225 | Invalid time range |
| 12226 | Invalid date [{date}] of month [{month}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12274 | Stat cycle with id [{id}] already exists in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Create stat cycle",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/create"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [CREATE]"
},
"x-errorCodes": {
"12225": "Invalid time range",
"12226": "Invalid date [{date}] of month [{month}]",
"20001": "Unauthorized",
"20013": "insufficient permission",
"12274": "Stat cycle with id [{id}] already exists in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statCycles/bulk": {
"post": {
"consumes": [
"application/json"
],
"description": "Bulk get stat cycle.
Other detail info:- Returns: list of stat cycles
",
"operationId": "bulkGetStatCycle",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkStatCycleRequest"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/BulkStatCycleResult"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk get stat cycle",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/bulk-get"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statCycles/export": {
"get": {
"description": "Export all stat cycle configurations for a given namespace into file At current, only JSON file is supported.",
"operationId": "exportStatCycle",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful export of stat cycle configs",
"schema": {
"type": "file"
}
},
"401": {
"description": "
| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Export all stat cycle configurations",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/export"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statCycles/import": {
"post": {
"consumes": [
"multipart/form-data"
],
"description": "Import stat cycle configurations for a given namespace from file. At current, only JSON file is supported.",
"operationId": "importStatCycle",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"in": "formData",
"name": "file",
"required": false,
"type": "file"
},
{
"description": "replaceExisting",
"in": "query",
"name": "replaceExisting",
"required": false,
"type": "boolean"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Import stat cycles successfully",
"schema": {
"$ref": "#/definitions/StatImportInfo"
}
},
"400": {
"description": "
| errorCode | errorMessage |
| 12222 | Stats data for namespace [{namespace}] is invalid |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Import stat cycle configurations",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/import"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [CREATE]"
},
"x-errorCodes": {
"12222": "Stats data for namespace [{namespace}] is invalid",
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statCycles/{cycleId}": {
"delete": {
"description": "Deletes stat cycle.
",
"operationId": "deleteStatCycle",
"parameters": [
{
"description": "cycle id",
"in": "path",
"name": "cycleId",
"required": true,
"type": "string"
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Successful operation"
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Deletes stat cycle",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/delete"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [DELETE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"20000": "Internal server error"
}
},
"get": {
"description": "Get stat cycle.
Other detail info:",
"operationId": "getStatCycle",
"parameters": [
{
"description": "cycle id",
"in": "path",
"name": "cycleId",
"required": true,
"type": "string"
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatCycleInfo"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Get stat cycle",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/get"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"20000": "Internal server error"
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Update stat cycle.
Other detail info:- STOPPED cycles cannot be updated
- If changing the start time of an ACTIVE cycle to a future time, the status will be set to INIT and the related user data will be removed
- If changing the cycle type of an ACTIVE cycle, the related user data will be removed
",
"operationId": "updateStatCycle",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatCycleUpdate"
}
},
{
"description": "cycle id",
"in": "path",
"name": "cycleId",
"required": true,
"type": "string"
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatCycleInfo"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12225 | Invalid time range |
| 12226 | Invalid date [{date}] of month [{month}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12277 | Stat cycle [{id}] in namespace [{namespace}] with status [{status}] cannot be updated |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Update stat cycle",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/update"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [UPDATE]"
},
"x-errorCodes": {
"12225": "Invalid time range",
"12226": "Invalid date [{date}] of month [{month}]",
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"12277": "Stat cycle [{id}] in namespace [{namespace}] with status [{status}] cannot be updated",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statCycles/{cycleId}/reset": {
"post": {
"description": "Reset stat cycle.
Other detail info:- This endpoint will reset the cycle immediately
",
"operationId": "resetStatCycle",
"parameters": [
{
"description": "cycle id",
"in": "path",
"name": "cycleId",
"required": true,
"type": "string"
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "successful operation"
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12279 | Invalid stat cycle status: Stat cycle [{id}], namespace [{namespace}], status [{status}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Reset stat cycle",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/reset"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"12279": "Invalid stat cycle status: Stat cycle [{id}], namespace [{namespace}], status [{status}]",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statCycles/{cycleId}/stats/add/bulk": {
"post": {
"consumes": [
"application/json"
],
"description": "Bulk add stat cycle to stats.
",
"operationId": "bulkAddStats",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkCycleStatsAdd"
}
},
{
"description": "cycle id",
"in": "path",
"name": "cycleId",
"required": true,
"type": "string"
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatCycleOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk add stat cycle to stats",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/bulk-add"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [CREATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statCycles/{cycleId}/stop": {
"put": {
"consumes": [
"application/json"
],
"description": "Stop stat cycle.
Other detail info:- Returns: updated stat cycle
",
"operationId": "stopStatCycle",
"parameters": [
{
"description": "cycle id",
"in": "path",
"name": "cycleId",
"required": true,
"type": "string"
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatCycleInfo"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12279 | Invalid stat cycle status: Stat cycle [{id}], namespace [{namespace}], status [{status}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Stop stat cycle",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-cycles/v1/stop"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"12279": "Invalid stat cycle status: Stat cycle [{id}], namespace [{namespace}], status [{status}]",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statitems/bulk": {
"get": {
"description": "Bulk fetch multiple user's statitem value for a given namespace and statCode. \nOther detail info:\n+ *Returns*: list of user's statItem",
"operationId": "bulkFetchStatItems",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "query",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "comma separated user Ids",
"in": "query",
"name": "userIds",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/UserStatItemInfo"
},
"type": "array"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk fetch statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/bulk-get-for-users"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statitems/value/bulk": {
"patch": {
"consumes": [
"application/json"
],
"description": "Bulk update multiple user's statitems value.
",
"operationId": "bulkIncUserStatItemValue",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkUserStatItemInc"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk update multiple user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/bulk-update-for-users"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Bulk update multiple user's statitems value.
Other detail info:- Returns: bulk updated result
",
"operationId": "bulkIncUserStatItem",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkUserStatItemInc"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk update multiple user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/bulk-set-for-users"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statitems/value/bulk/getOrDefault": {
"get": {
"description": "Bulk fetch multiple user's stat item values for a given namespace and statCode.\nNOTE: If stat item does not exist, will return default value. Other detail info:\n+ *Returns*: list of user's stat item values",
"operationId": "bulkFetchOrDefaultStatItems",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "query",
"name": "statCode",
"required": true,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "user ids",
"in": "query",
"items": {
"type": "string"
},
"name": "userIds",
"required": true,
"type": "array"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A DTO object for user stat item value"
},
"type": "array"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk fetch user stat item values",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/bulk-get-by-code"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/statitems/value/reset/bulk": {
"put": {
"consumes": [
"application/json"
],
"description": "Bulk reset multiple user's statitems value.\nUser's statitem value will be reset to the default value defined in the statistic configuration.\n\nOther detail info:\n+ *Returns*: bulk updated result",
"operationId": "bulkResetUserStatItem",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkUserStatItemReset"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk reset multiple user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/bulk-reset-for-users"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/stats": {
"get": {
"description": "List stats by pagination.
Other detail info:",
"operationId": "getStats",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "comma separated cycleId",
"in": "query",
"name": "cycleIds",
"required": false,
"type": "string"
},
{
"description": "flag to filter global statcode",
"in": "query",
"name": "isGlobal",
"required": false,
"type": "boolean"
},
{
"description": "flag to filter public/private statcode",
"in": "query",
"name": "isPublic",
"required": false,
"type": "boolean"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatPagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List stats",
"tags": [
"StatConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-definitions/v1/list"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Create stat.
Other detail info:- Returns: created stat template
- default minimum value is 0
- default maximum value is 1.7976931348623157e+308
- Field globalAggregationMethod will be ignored when setAsGlobal field is false
",
"operationId": "createStat",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatCreate"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Create stat successfully",
"schema": {
"$ref": "#/definitions/StatInfo"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12271 | Stat template with code [{statCode}] already exists in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Create stat",
"tags": [
"StatConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-definitions/v1/create"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [CREATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"12271": "Stat template with code [{statCode}] already exists in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/stats/export": {
"get": {
"description": "Export all stat configurations for a given namespace into file At current, only JSON file is supported.",
"operationId": "exportStats",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful export of stat configs",
"schema": {
"type": "file"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Export all stat configurations",
"tags": [
"StatConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-definitions/v1/export"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/stats/import": {
"post": {
"consumes": [
"multipart/form-data"
],
"description": "Import stat configurations for a given namespace from file. At current, only JSON file is supported.",
"operationId": "importStats",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"in": "formData",
"name": "file",
"required": false,
"type": "file"
},
{
"description": "replaceExisting",
"in": "query",
"name": "replaceExisting",
"required": false,
"type": "boolean"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Import stats successfully",
"schema": {
"$ref": "#/definitions/StatImportInfo"
}
},
"400": {
"description": "| errorCode | errorMessage |
| 12222 | Stats data for namespace [{namespace}] is invalid |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Import stat configurations",
"tags": [
"StatConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-definitions/v1/import"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [CREATE]"
},
"x-errorCodes": {
"12222": "Stats data for namespace [{namespace}] is invalid",
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/stats/search": {
"get": {
"description": "Query stats by keyword.
Other detail info:",
"operationId": "queryStats",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "keyword",
"in": "query",
"name": "keyword",
"required": true,
"type": "string"
},
{
"description": "flag to filter global statcode",
"in": "query",
"name": "isGlobal",
"required": false,
"type": "boolean"
},
{
"description": "flag to filter public/private statecode",
"in": "query",
"name": "isPublic",
"required": false,
"type": "boolean"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatPagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Query stats by keyword",
"tags": [
"StatConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-definitions/v1/search"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/stats/{statCode}": {
"delete": {
"description": "Deletes stat template.
",
"operationId": "deleteStat",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Successful delete of stat"
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Deletes stat",
"tags": [
"StatConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-definitions/v1/delete"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [DELETE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"20000": "Internal server error"
}
},
"get": {
"description": "Get stat by statCode.
Other detail info:",
"operationId": "getStat",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat Code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatInfo"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Get stat by statCode",
"tags": [
"StatConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-definitions/v1/get"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"20000": "Internal server error"
}
},
"patch": {
"consumes": [
"application/json"
],
"description": "Update stat.
Update a TIED stat will affect users' data, the updated stat will take effect in the next evaluation.
Other detail info:- Returns: updated stat
- Field globalAggregationMethod will be ignored when the stat is not set as global
",
"operationId": "updateStat",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatUpdate"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful update of stat",
"schema": {
"$ref": "#/definitions/StatInfo"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Update stat",
"tags": [
"StatConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-definitions/v1/update"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/stats/{statCode}/statitems": {
"get": {
"description": "Get users' stat item values for a given namespace and statCode.\nOther info:\n+ *Returns*: list of users' stat item values",
"operationId": "getStatItems",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat Code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"default": "value:desc",
"description": "default is value:desc, allowed values: [value, value:asc, value:desc]",
"in": "query",
"name": "sortBy",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatItemValuePagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Get users' stat item values by stat code",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/get"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/stats/{statCode}/tied": {
"delete": {
"description": "Deletes stat template.",
"operationId": "deleteTiedStat",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Successfully delete the stat of tied status"
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12276 | Stat template with code [{statCode}] in namespace [{namespace}] not deletable due it is in an INIT status |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Deletes tied stat",
"tags": [
"StatConfiguration"
],
"x-operationId": {
"value": "social/admin/stat-definitions/v1/delete-tied"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STAT [DELETE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"12276": " Stat template with code [{statCode}] in namespace [{namespace}] not deletable due it is in an INIT status ",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/users/{userId}/statCycles/{cycleId}/statCycleitems": {
"get": {
"description": "List user's statCycleItems by statCycle.
Other detail info:- Returns: stat cycle items
",
"operationId": "getUserStatCycleItems",
"parameters": [
{
"description": "cycle id",
"in": "path",
"name": "cycleId",
"required": true,
"type": "string"
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "flag to filter which data to show.\n - Unfiltered will return all data
- If set to false will return private user stat items only
- If set to true will return public stat items only
",
"in": "query",
"name": "isPublic",
"required": false,
"type": "boolean"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"description": "default is unsorted, allow values: [statCode, statCode:asc, statCode:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc],and support sort group, eg: sortBy=statCode:asc,createdAt:desc.",
"in": "query",
"name": "sortBy",
"required": false,
"type": "string"
},
{
"description": "comma separated stat codes",
"in": "query",
"name": "statCodes",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserStatCycleItemPagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List user's statCycleItems by statCycle",
"tags": [
"UserStatisticCycle"
],
"x-operationId": {
"value": "social/admin/user-stat-cycles/v1/list"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/users/{userId}/statitems": {
"get": {
"description": "List user's statItems.
Other detail info:",
"operationId": "getUserStatItems",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "flag to filter which data to show.\n - Unfiltered will return all data
- If set to false will return private user stat items only
- If set to true will return public stat items only
",
"in": "query",
"name": "isPublic",
"required": false,
"type": "boolean"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"default": "updatedAt:asc",
"description": "default is updatedAt:asc, allow values: [statCode, statCode:asc, statCode:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc],and support sort group, eg: sortBy=statCode:asc,createdAt:desc.",
"in": "query",
"name": "sortBy",
"required": false,
"type": "string"
},
{
"description": "stat codes",
"in": "query",
"name": "statCodes",
"required": false,
"type": "string"
},
{
"description": "tags",
"in": "query",
"name": "tags",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserStatItemPagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List user's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/list"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/users/{userId}/statitems/bulk": {
"post": {
"consumes": [
"application/json"
],
"description": "Bulk create user's statItems.
Other detail info:- Returns: bulk created result
",
"operationId": "bulkCreateUserStatItems",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkStatItemCreate"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk create user's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/bulk-create"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [CREATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/users/{userId}/statitems/value/bulk": {
"patch": {
"consumes": [
"application/json"
],
"description": "Bulk update user's statitems value.
Other detail info:- Returns: bulk updated result
",
"operationId": "bulkIncUserStatItemValue_1",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkStatItemInc"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk update user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/bulk-update-user"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Bulk update user's statitems value.
Other detail info:- Returns: bulk updated result
",
"operationId": "bulkIncUserStatItem_1",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkStatItemInc"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk update user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/bulk-set"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/users/{userId}/statitems/value/reset/bulk": {
"put": {
"consumes": [
"application/json"
],
"description": "Bulk reset user's statitems value for given namespace and user. \nOther detail info:\n+ *Returns*: bulk updated result",
"operationId": "bulkResetUserStatItem_1",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkStatItemReset"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk reset user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/bulk-reset"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/users/{userId}/stats/{statCode}/statitems": {
"delete": {
"description": "This endpoint is for testing purpose. Use this endpoint for cleaning up after testing.
Delete user's statItems given stat code.
Other detail info:- Returns: no content
",
"operationId": "deleteUserStatItems",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "delete successfully"
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12242 | Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Delete User's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/delete"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [DELETE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12242": "Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Create statItem for a user.
Other detail info:- Returns: created user's statItem
",
"operationId": "createUserStatItem",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Create user statItem successfully"
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12274 | Stat item with code [{statCode}] of user [{profileId}] already exists in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Create user's statItem",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/create"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [CREATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"12274": "Stat item with code [{statCode}] of user [{profileId}] already exists in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/users/{userId}/stats/{statCode}/statitems/value": {
"patch": {
"consumes": [
"application/json"
],
"description": "Update user's statitem value.
Other detail info:- Returns: updated user's statItem
",
"operationId": "incUserStatItemValue",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatItemInc"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatItemIncResult"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12221 | Invalid stat operator, expect [{expected}] but actual [{actual}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
| 12242 | Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12273 | Stat [{statCode}] is not decreasable |
| 12275 | [{action}] value: [{value}] of stat [{statCode}] is out of range while minimum [{minimum}] and maximum [{maximum}] in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Update user's statitem value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/update"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"12221": "Invalid stat operator, expect [{expected}] but actual [{actual}]",
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"12242": "Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}]",
"12273": "Stat [{statCode}] is not decreasable",
"12275": "[{action}] value: [{value}] of stat [{statCode}] is out of range while minimum [{minimum}] and maximum [{maximum}] in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/admin/namespaces/{namespace}/users/{userId}/stats/{statCode}/statitems/value/reset": {
"put": {
"consumes": [
"application/json"
],
"description": "Reset user's statitem value for a given namespace and user.\nUser's statitem value will be reset to the default value defined in the statistic configuration.\n\nOther detail info:\n+ *Returns*: updated user's statItem",
"operationId": "resetUserStatItemValue",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatResetInfo"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatItemIncResult"
}
},
"400": {
"description": "| errorCode | errorMessage |
| 12221 | Invalid stat operator, expect [{expected}] but actual [{actual}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| errorCode | errorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Reset user's statitem value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v1/reset"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"12221": "Invalid stat operator, expect [{expected}] but actual [{actual}]",
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/globalstatitems": {
"get": {
"description": "List global statItems by pagination.
Other detail info:",
"operationId": "getGlobalStatItems_1",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"description": "comma separated stat codes",
"in": "query",
"name": "statCodes",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GlobalStatItemPagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List global statItems",
"tags": [
"GlobalStatistic"
],
"x-operationId": {
"value": "social/public/global-stat-values/v1/list"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/globalstatitems/{statCode}": {
"get": {
"description": "Get global statItem by stat code.
Other detail info:- Returns: global stat item
",
"operationId": "getGlobalStatItemByStatCode_1",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat Code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/GlobalStatItemInfo"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12244 | Global stat item of [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Get global statItem by stat code",
"tags": [
"GlobalStatistic"
],
"x-operationId": {
"value": "social/public/global-stat-values/v1/get"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12244": "Global stat item of [{statCode}] cannot be found in namespace [{namespace}]",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/statCycles": {
"get": {
"description": "List stat cycles by pagination.
Other detail info:",
"operationId": "getStatCycles_1",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"enum": [
"ANNUALLY",
"DAILY",
"MONTHLY",
"SEASONAL",
"WEEKLY"
],
"in": "query",
"name": "cycleType",
"required": false,
"type": "string"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"description": "name",
"in": "query",
"name": "name",
"required": false,
"type": "string"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"description": "default is unsorted, allow values: [start, start:asc, start:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc],and support sort group, eg: sortBy=start:asc,createdAt:desc.",
"in": "query",
"name": "sortBy",
"required": false,
"type": "string"
},
{
"enum": [
"ACTIVE",
"INIT",
"STOPPED"
],
"in": "query",
"name": "status",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatCyclePagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List stat cycles",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/public/stat-cycles/v1/list"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/statCycles/bulk": {
"post": {
"consumes": [
"application/json"
],
"description": "Bulk get stat cycle.
Other detail info:- Returns: list of stat cycles
",
"operationId": "bulkGetStatCycle_1",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkStatCycleRequest"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/BulkStatCycleResult"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk get stat cycle",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/public/stat-cycles/v1/bulk-get"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/statCycles/{cycleId}": {
"get": {
"description": "Get stat cycle.
Other detail info:",
"operationId": "getStatCycle_1",
"parameters": [
{
"description": "cycle id",
"in": "path",
"name": "cycleId",
"required": true,
"type": "string"
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatCycleInfo"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Get stat cycle",
"tags": [
"StatCycleConfiguration"
],
"x-operationId": {
"value": "social/public/stat-cycles/v1/get"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STAT [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/statitems/bulk": {
"get": {
"description": "Public bulk fetch multiple user's statitem value for a given namespace and statCode. \nOther detail info:\n+ *Returns*: list of user's statItem",
"operationId": "bulkFetchStatItems_1",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "query",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "comma separated user Ids",
"in": "query",
"name": "userIds",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/UserStatItemInfo"
},
"type": "array"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public bulk fetch statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/bulk-get-for-users"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/statitems/value/bulk": {
"patch": {
"consumes": [
"application/json"
],
"description": "Public bulk update multiple user's statitems value.
Other detail info:- Returns: bulk updated result
",
"operationId": "publicBulkIncUserStatItemValue",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkUserStatItemInc"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public bulk update multiple user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/bulk-update-for-users"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Public bulk update multiple user's statitems value.
Other detail info:- Returns: bulk updated result
",
"operationId": "publicBulkIncUserStatItem",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkUserStatItemInc"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public bulk update multiple user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/bulk-set-for-users"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/statitems/value/reset/bulk": {
"put": {
"consumes": [
"application/json"
],
"description": "Bulk reset multiple user's statitems value. \nUser's statitem value will be reset to the default value defined in the statistic configuration.\n\nOther detail info:\n+ *Returns*: bulk updated result",
"operationId": "bulkResetUserStatItem_2",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkUserStatItemReset"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public bulk reset multiple user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/bulk-reset-for-users"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/stats": {
"post": {
"consumes": [
"application/json"
],
"description": "Create stat.
Other detail info:- Returns: created stat template
- default minimum value is 0
- default maximum value is 1.7976931348623157e+308
- Field globalAggregationMethod will be ignored when setAsGlobal field is false
",
"operationId": "createStat_1",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatCreate"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Create stat successfully",
"schema": {
"$ref": "#/definitions/StatInfo"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12271 | Stat template with code [{statCode}] already exists in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Create stat",
"tags": [
"StatConfiguration"
],
"x-operationId": {
"value": "social/public/stat-definitions/v1/create"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STAT [CREATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"12271": "Stat template with code [{statCode}] already exists in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/users/me/statCycles/{cycleId}/statCycleitems": {
"get": {
"description": "List user's statCycleItems by statCycle.
Other detail info:- Returns: stat cycle items
",
"operationId": "publicListMyStatCycleItems",
"parameters": [
{
"description": "cycle id",
"in": "path",
"name": "cycleId",
"required": true,
"type": "string"
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"description": "default is unsorted, allow values: [statCode, statCode:asc, statCode:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc],and support sort group, eg: sortBy=statCode:asc,createdAt:desc.",
"in": "query",
"name": "sortBy",
"required": false,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "stat codes",
"in": "query",
"items": {
"type": "string"
},
"name": "statCodes",
"required": false,
"type": "array"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserStatCycleItemPagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List user's statCycleItems by statCycle",
"tags": [
"UserStatisticCycle"
],
"x-operationId": {
"value": "social/public/user-stat-cycles/v1/list-my"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/users/me/statitems": {
"get": {
"description": "Public list all statItems by pagination.
Other detail info:",
"operationId": "publicListMyStatItems",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"description": "default is unsorted, allow values: [statCode, statCode:asc, statCode:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc],and support sort group, eg: sortBy=statCode:asc,createdAt:desc.",
"in": "query",
"name": "sortBy",
"required": false,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "stat codes",
"in": "query",
"items": {
"type": "string"
},
"name": "statCodes",
"required": false,
"type": "array"
},
{
"collectionFormat": "multi",
"description": "tags",
"in": "query",
"items": {
"type": "string"
},
"name": "tags",
"required": false,
"type": "array"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserStatItemPagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public list user's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/list-my"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/users/me/statitems/value/bulk": {
"get": {
"description": "Public list all statItems of user.
NOTE: - If stat code does not exist, will ignore this stat code.
- If stat item does not exist, will return default value
Other detail info:",
"operationId": "publicListAllMyStatItems",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "stat codes",
"in": "query",
"items": {
"type": "string"
},
"name": "statCodes",
"required": false,
"type": "array"
},
{
"collectionFormat": "multi",
"description": "tags",
"in": "query",
"items": {
"type": "string"
},
"name": "tags",
"required": false,
"type": "array"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A DTO object for user stat item value"
},
"type": "array"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12223 | Invalid stat codes in namespace [{namespace}]: [{statCodes}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12243 | Stats cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public list user's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/bulk-get-my"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [READ]"
},
"x-errorCodes": {
"12223": "Invalid stat codes in namespace [{namespace}]: [{statCodes}]",
"20013": "insufficient permission",
"12243": "Stats cannot be found in namespace [{namespace}]",
"20002": "validation error"
}
}
},
"/v1/public/namespaces/{namespace}/users/{userId}/statCycles/{cycleId}/statCycleitems": {
"get": {
"description": "List user's statCycleItems by statCycle.
Other detail info:- Returns: stat cycle items
",
"operationId": "getUserStatCycleItems_1",
"parameters": [
{
"description": "cycle id",
"in": "path",
"name": "cycleId",
"required": true,
"type": "string"
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"description": "default is unsorted, allow values: [statCode, statCode:asc, statCode:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc],and support sort group, eg: sortBy=statCode:asc,createdAt:desc.",
"in": "query",
"name": "sortBy",
"required": false,
"type": "string"
},
{
"description": "comma separated stat codes",
"in": "query",
"name": "statCodes",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserStatCycleItemPagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12245 | Stat cycle [{id}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "List user's statCycleItems by statCycle",
"tags": [
"UserStatisticCycle"
],
"x-operationId": {
"value": "social/public/user-stat-cycles/v1/list"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12245": "Stat cycle [{id}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/users/{userId}/statitems": {
"get": {
"description": "Public list all statItems by pagination.
Other detail info:",
"operationId": "publicQueryUserStatItems_1",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"default": 20,
"format": "int32",
"in": "query",
"name": "limit",
"required": false,
"type": "integer"
},
{
"default": 0,
"format": "int32",
"in": "query",
"name": "offset",
"required": false,
"type": "integer"
},
{
"description": "default is unsorted, allow values: [statCode, statCode:asc, statCode:desc, createdAt, createdAt:asc, createdAt:desc, updatedAt, updatedAt:asc, updatedAt:desc],and support sort group, eg: sortBy=statCode:asc,createdAt:desc.",
"in": "query",
"name": "sortBy",
"required": false,
"type": "string"
},
{
"description": "stat codes",
"in": "query",
"name": "statCodes",
"required": false,
"type": "string"
},
{
"description": "tags",
"in": "query",
"name": "tags",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/UserStatItemPagingSlicedResult"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public list user's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/list"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/users/{userId}/statitems/bulk": {
"post": {
"consumes": [
"application/json"
],
"description": "Bulk create statItems.
Other detail info:- Returns: bulk created result
",
"operationId": "publicBulkCreateUserStatItems",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkStatItemCreate"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk create user's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/bulk-create"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [CREATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/users/{userId}/statitems/value/bulk": {
"get": {
"description": "Public list all statItems of user.
NOTE: - If stat code does not exist, will ignore this stat code.
- If stat item does not exist, will return default value
Other detail info:",
"operationId": "publicQueryUserStatItems",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user id",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "stat codes",
"in": "query",
"items": {
"type": "string"
},
"name": "statCodes",
"required": false,
"type": "array"
},
{
"collectionFormat": "multi",
"description": "tags",
"in": "query",
"items": {
"type": "string"
},
"name": "tags",
"required": false,
"type": "array"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A DTO object for user stat item value"
},
"type": "array"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12223 | Invalid stat codes in namespace [{namespace}]: [{statCodes}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12243 | Stats cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public list user's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/bulk-get"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [READ]"
},
"x-errorCodes": {
"12223": "Invalid stat codes in namespace [{namespace}]: [{statCodes}]",
"20001": "Unauthorized",
"20013": "insufficient permission",
"12243": "Stats cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
},
"patch": {
"consumes": [
"application/json"
],
"description": "Public bulk update user's statitems value.
Other detail info:- Returns: bulk updated result
",
"operationId": "bulkIncUserStatItemValue_2",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkStatItemInc"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public bulk update user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/bulk-update-user"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Public bulk update user's statitems value.
Other detail info:- Returns: bulk updated result
",
"operationId": "publicBulkIncUserStatItem_1",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkStatItemInc"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public bulk update user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/bulk-set"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/users/{userId}/statitems/value/reset/bulk": {
"put": {
"consumes": [
"application/json"
],
"description": "Public bulk reset user's statitems value for given namespace and user. \nOther detail info:\n+ *Returns*: bulk updated result",
"operationId": "bulkResetUserStatItem_3",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkStatItemReset"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public bulk reset user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/bulk-reset"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/users/{userId}/stats/{statCode}/statitems": {
"delete": {
"description": "Delete user's statItems given stat code.
Other detail info:- Returns: no content
",
"operationId": "deleteUserStatItems_1",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "delete successfully"
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12242 | Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Delete User's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/delete"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [DELETE]"
},
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission",
"12242": "Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
},
"post": {
"consumes": [
"application/json"
],
"description": "Create user's statItem.
Other detail info:- Returns: created user's statItem
",
"operationId": "publicCreateUserStatItem",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"201": {
"description": "Create user statItem successfully"
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12274 | Stat item with code [{statCode}] of user [{profileId}] already exists in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Create user's statItem",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/create"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [CREATE]"
},
"x-errorCodes": {
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"12274": "Stat item with code [{statCode}] of user [{profileId}] already exists in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/users/{userId}/stats/{statCode}/statitems/value": {
"patch": {
"consumes": [
"application/json"
],
"description": "Public update user's statitem value.
Other detail info:- Returns: updated user's statItem
",
"operationId": "publicIncUserStatItemValue",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatItemInc"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatItemIncResult"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12221 | Invalid stat operator, expect [{expected}] but actual [{actual}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
| 12242 | Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12273 | Stat [{statCode}] is not decreasable |
| 12275 | [{action}] value: [{value}] of stat [{statCode}] is out of range while minimum [{minimum}] and maximum [{maximum}] in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public update user's statitem value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/update"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"12221": "Invalid stat operator, expect [{expected}] but actual [{actual}]",
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"12242": "Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}]",
"12273": "Stat [{statCode}] is not decreasable",
"12275": "[{action}] value: [{value}] of stat [{statCode}] is out of range while minimum [{minimum}] and maximum [{maximum}] in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Public update user's statitem value.
Other detail info:- Returns: updated user's statItem
",
"operationId": "publicIncUserStatItem",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatItemInc"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatItemIncResult"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12221 | Invalid stat operator, expect [{expected}] but actual [{actual}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
| 12242 | Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12273 | Stat [{statCode}] is not decreasable |
| 12275 | [{action}] value: [{value}] of stat [{statCode}] is out of range while minimum [{minimum}] and maximum [{maximum}] in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public update user's statitem value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/set"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"12221": "Invalid stat operator, expect [{expected}] but actual [{actual}]",
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"12242": "Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}]",
"12273": "Stat [{statCode}] is not decreasable",
"12275": "[{action}] value: [{value}] of stat [{statCode}] is out of range while minimum [{minimum}] and maximum [{maximum}] in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v1/public/namespaces/{namespace}/users/{userId}/stats/{statCode}/statitems/value/reset": {
"put": {
"consumes": [
"application/json"
],
"description": "Reset user's statitem value for a given namespace and user.\nUser's statitem value will be reset to the default value defined in the statistic configuration.\n\nOther detail info:\n+ *Returns*: updated user's statItem",
"operationId": "resetUserStatItemValue_1",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatItemIncResult"
}
},
"400": {
"description": "| errorCode | errorMessage |
| 12221 | Invalid stat operator, expect [{expected}] but actual [{actual}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | Unauthorized |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| errorCode | errorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public reset user's statitem value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v1/reset"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"12221": "Invalid stat operator, expect [{expected}] but actual [{actual}]",
"20001": "Unauthorized",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v2/admin/namespaces/{namespace}/statitems/value/bulk": {
"put": {
"consumes": [
"application/json"
],
"description": "Bulk update multiple user's statitems value with specific update strategy. \nThere are four supported update strategies:\n+ *OVERRIDE*: update user statitem with the new value\n+ *INCREMENT*: increment user statitem with the specified value\n+ *MAX*: update user statitem with the specified value if it's larger than the existing value\n+ *MIN*: update user statitem with the specified value if it's lower than the existing value\n\nOther detail info:\n+ *Returns*: bulk updated result\n\n\n
\u26a0\ufe0f Important Note on Bulk Update Behavior
\n
\n To ensure data integrity and avoid inconsistencies or race conditions, it is crucial to make each user/update pair unique per request.\n We strongly advise against including multiple updates for the same userId with the same statCode and/or updateStrategy in a single request,\n as bulk operations are processed concurrently.\n
\n
\n Avoid including multiple entries with the same userId and statCode but different updateStrategy values.\n
\n
\n To apply multiple operations on the same stat, please batch or sequence them in separate requests, according to your business logic.\n
\n\n \u274c Incorrect Example:\n\n [\n {\n \"userId\": \"315a070e48a74dae903d559974e6513d\",\n \"statCode\": \"exp\",\n \"updateStrategy\": \"OVERRIDE\",\n \"value\": 10\n },\n {\n \"userId\": \"315a070e48a74dae903d559974e6513d\",\n \"statCode\": \"exp\",\n \"updateStrategy\": \"INCREMENT\",\n \"value\": 50\n }\n ]\n\n \u2705 Correct Example:\n\n [\n {\n \"userId\": \"315a070e48a74dae903d559974e6513d\",\n \"statCode\": \"exp\",\n \"updateStrategy\": \"INCREMENT\",\n \"value\": 60\n }\n ]\n
\n\n\n",
"operationId": "bulkUpdateUserStatItemV2",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkUserStatItemUpdate"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk update multiple user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v2/bulk-update-for-users"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v2/admin/namespaces/{namespace}/statitems/value/bulk/getOrDefault": {
"get": {
"description": "Bulk fetch multiple user's stat item values for a given namespace and statCode.\nNOTE: If stat item does not exist, will return default value. Other detail info:\n+ *Returns*: list of user's stat item values",
"operationId": "bulkFetchOrDefaultStatItems_1",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "query",
"name": "statCode",
"required": true,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "user ids",
"in": "query",
"items": {
"type": "string"
},
"name": "userIds",
"required": true,
"type": "array"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A DTO object for user stat item value"
},
"type": "array"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk fetch user stat item values",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v2/bulk-get-by-code"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v2/admin/namespaces/{namespace}/users/{userId}/statitems/value/bulk": {
"get": {
"description": "Admin list all statItems of user
NOTE: Legacy endpoint, please use POST /v2/admin/namespaces/{namespace}/users/{userId}/statitems/value/bulk/getOrDefault- If stat code does not exist, will ignore this stat code.
- If stat item does not exist, will return default value
Other detail info:",
"operationId": "AdminListUsersStatItems",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user id",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "stat codes",
"in": "query",
"items": {
"type": "string"
},
"name": "statCodes",
"required": false,
"type": "array"
},
{
"collectionFormat": "multi",
"description": "tags",
"in": "query",
"items": {
"type": "string"
},
"name": "tags",
"required": false,
"type": "array"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A DTO object for user stat item value"
},
"type": "array"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12223 | Invalid stat codes in namespace [{namespace}]: [{statCodes}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12243 | Stats cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "(Legacy) Admin list user's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v2/list"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:STATITEM [READ]"
},
"x-errorCodes": {
"12223": "Invalid stat codes in namespace [{namespace}]: [{statCodes}]",
"20001": "unauthorized access",
"20013": "insufficient permission",
"12243": "Stats cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Bulk update user's statitems value for given namespace and user with specific update strategy. \nThere are four supported update strategies:\n+ *OVERRIDE*: update user statitem with the new value\n+ *INCREMENT*: increment user statitem with the specified value\n+ *MAX*: update user statitem with the specified value if it's larger than the existing value\n+ *MIN*: update user statitem with the specified value if it's lower than the existing value\n\nThe *additionalKey* parameter will be suffixed to *userId* and is used to support multi level user's statitems, such as character's statitems. \nIf provided, user's statitems will be saved with key: *userId_additionalKey* \n\nOther detail info:\n+ *Returns*: bulk updated result\n\n\n
\u26a0\ufe0f Important Note on Bulk Update Behavior
\n
\n To ensure data integrity and avoid inconsistencies or race conditions, it is crucial to make each stat update unique per request.\n We strongly advise against including multiple updates for the same statCode with the same updateStrategy in a single request,\n as bulk operations are processed concurrently.\n
\n
\n Avoid including multiple entries with the same statCode but different updateStrategy values.\n
\n
\n To apply multiple operations on the same stat, please batch or sequence them in separate requests, according to your business logic.\n
\n\n \u274c Incorrect Example:\n\n [\n {\n \"statCode\": \"exp\",\n \"updateStrategy\": \"OVERRIDE\",\n \"value\": 10\n },\n {\n \"statCode\": \"exp\",\n \"updateStrategy\": \"INCREMENT\",\n \"value\": 50\n }\n ]\n\n \u2705 Correct Example:\n\n [\n {\n \"statCode\": \"exp\",\n \"updateStrategy\": \"OVERRIDE\",\n \"value\": 10\n }.\n {\n \"statCode\": \"headshot\",\n \"updateStrategy\": \"INCREMENT\",\n \"value\": 10\n }\n ]\n
\n\n\n",
"operationId": "bulkUpdateUserStatItem",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkStatItemUpdate"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk update user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v2/bulk-update"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v2/admin/namespaces/{namespace}/users/{userId}/statitems/value/bulk/getOrDefault": {
"post": {
"consumes": [
"application/json"
],
"description": "Bulk get user's statitems value for given namespace and user by multiple stat codes. \nWill return default value if player doesn't have the stat. \nOther detail info:\n+ *Required permission*: resource=\"ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM\", action=2 (READ)\n+ *Max stat codes*: 20\n+ *Returns*: list of user's stat item values",
"operationId": "bulkGetOrDefaultByUserId",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/BulkUserStatItemByStatCodes"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A DTO object for user stat item value"
},
"type": "array"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk get user's statitems value by user id and multiple stat codes",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v2/bulk-get"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [READ]"
},
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v2/admin/namespaces/{namespace}/users/{userId}/statitems/value/reset/bulk": {
"put": {
"consumes": [
"application/json"
],
"description": "Bulk reset user's statitem values for given namespace and user. \nOther detail info:\n+ *Returns*: bulk updated result",
"operationId": "bulkResetUserStatItemValues",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/A DTO object for resetting user stat items"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Bulk reset user's statitem values",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v2/bulk-reset"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v2/admin/namespaces/{namespace}/users/{userId}/stats/{statCode}/statitems": {
"delete": {
"description": "Delete user's stat items for given namespace, statCode, and user Id. \nIf query param *additionalKey* is provided, it will delete user stat items of specific key (i.e. characterName). \nOtherwise, it will delete all stat items related to the user Id. \n
Delete user's statItems given stat code.
Other detail info:- Returns: no content
",
"operationId": "deleteUserStatItems_2",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"204": {
"description": "delete successfully"
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12242 | Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Delete User's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v2/delete"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [DELETE]"
},
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission",
"12242": "Stat item of [{statCode}] of user [{profileId}] cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v2/admin/namespaces/{namespace}/users/{userId}/stats/{statCode}/statitems/value": {
"put": {
"consumes": [
"application/json"
],
"description": "Update user's statitem value for a given namespace and user with a certain update strategy.\nThere are four supported update strategies:\n+ *OVERRIDE*: update user statitem with the new value\n+ *INCREMENT*: increment user statitem with the specified value\n+ *MAX*: update user statitem with the specified value if it's larger than the existing value\n+ *MIN*: update user statitem with the specified value if it's lower than the existing value\n\nThe *additionalKey* parameter will be suffixed to *userId* and is used to support multi level user's statitems, such as character's statitems. \nIf provided, user's statitems will be saved with key: *userId_additionalKey* \n\nOther detail info:\n+ *Returns*: updated user's statItem",
"operationId": "updateUserStatItemValue",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatItemUpdate"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatItemIncResult"
}
},
"400": {
"description": "| errorCode | errorMessage |
| 12221 | Invalid stat operator, expect [{expected}] but actual [{actual}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| errorCode | errorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12273 | Stat [{statCode}] is not decreasable |
| 12275 | [{action}] value: [{value}] of stat [{statCode}] is out of range while minimum [{minimum}] and maximum [{maximum}] in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Update user's statitem value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/admin/user-stat-values/v2/update"
},
"x-security": {
"userPermissions": "ADMIN:NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"12221": "Invalid stat operator, expect [{expected}] but actual [{actual}]",
"20001": "unauthorized access",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"12273": "Stat [{statCode}] is not decreasable",
"12275": "[{action}] value: [{value}] of stat [{statCode}] is out of range while minimum [{minimum}] and maximum [{maximum}] in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v2/public/namespaces/{namespace}/statitems/value/bulk": {
"put": {
"consumes": [
"application/json"
],
"description": "Public bulk update multiple user's statitems value with specific update strategy. \nThere are four supported update strategies:\n+ *OVERRIDE*: update user statitem with the new value\n+ *INCREMENT*: increment user statitem with the specified value\n+ *MAX*: update user statitem with the specified value if it's larger than the existing value\n+ *MIN*: update user statitem with the specified value if it's lower than the existing value\n\nOther detail info:\n+ *Returns*: bulk updated result\n\n\n
\u26a0\ufe0f Important Note on Bulk Update Behavior
\n
\n To ensure data integrity and avoid inconsistencies or race conditions, it is crucial to make each user/update pair unique per request.\n We strongly advise against including multiple updates for the same userId with the same statCode and/or updateStrategy in a single request,\n as bulk operations are processed concurrently.\n
\n
\n Avoid including multiple entries with the same userId and statCode but different updateStrategy values.\n
\n
\n To apply multiple operations on the same stat, please batch or sequence them in separate requests, according to your business logic.\n
\n\n \u274c Incorrect Example:\n\n [\n {\n \"userId\": \"315a070e48a74dae903d559974e6513d\",\n \"statCode\": \"exp\",\n \"updateStrategy\": \"OVERRIDE\",\n \"value\": 10\n },\n {\n \"userId\": \"315a070e48a74dae903d559974e6513d\",\n \"statCode\": \"exp\",\n \"updateStrategy\": \"INCREMENT\",\n \"value\": 50\n }\n ]\n\n \u2705 Correct Example:\n\n [\n {\n \"userId\": \"315a070e48a74dae903d559974e6513d\",\n \"statCode\": \"exp\",\n \"updateStrategy\": \"INCREMENT\",\n \"value\": 60\n }\n ]\n
\n\n\n",
"operationId": "bulkUpdateUserStatItem_1",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkUserStatItemUpdate"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public bulk update multiple user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v2/bulk-update-for-users"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v2/public/namespaces/{namespace}/users/{userId}/statitems/value/bulk": {
"get": {
"description": "Public list all statItems of user.
NOTE: - If stat code does not exist, will ignore this stat code.
- If stat item does not exist, will return default value
Other detail info:",
"operationId": "publicQueryUserStatItems_2",
"parameters": [
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user id",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
},
{
"collectionFormat": "multi",
"description": "stat codes",
"in": "query",
"items": {
"type": "string"
},
"name": "statCodes",
"required": false,
"type": "array"
},
{
"collectionFormat": "multi",
"description": "tags",
"in": "query",
"items": {
"type": "string"
},
"name": "tags",
"required": false,
"type": "array"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/A DTO object for user stat item value"
},
"type": "array"
}
},
"400": {
"description": "| ErrorCode | ErrorMessage |
| 12223 | Invalid stat codes in namespace [{namespace}]: [{statCodes}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| ErrorCode | ErrorMessage |
| 12243 | Stats cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| ErrorCode | ErrorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public list user's statItems",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v2/bulk-get"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [READ]"
},
"x-errorCodes": {
"12223": "Invalid stat codes in namespace [{namespace}]: [{statCodes}]",
"20001": "unauthorized access",
"20013": "insufficient permission",
"12243": "Stats cannot be found in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
},
"put": {
"consumes": [
"application/json"
],
"description": "Public bulk update user's statitems value for given namespace and user with specific update strategy. \nThere are four supported update strategies:\n+ *OVERRIDE*: update user statitem with the new value\n+ *INCREMENT*: increment user statitem with the specified value\n+ *MAX*: update user statitem with the specified value if it's larger than the existing value\n+ *MIN*: update user statitem with the specified value if it's lower than the existing value\n\nThe *additionalKey* parameter will be suffixed to *userId* and is used to support multi level user's statitems, such as character's statitems. \nIf provided, user's statitems will be saved with key: *userId_additionalKey* \n\nOther detail info:\n+ *Returns*: bulk updated result\n\n\n
\u26a0\ufe0f Important Note on Bulk Update Behavior
\n
\n To ensure data integrity and avoid inconsistencies or race conditions, it is crucial to make each stat update unique per request.\n We strongly advise against including multiple updates for the same statCode with the same updateStrategy in a single request,\n as bulk operations are processed concurrently.\n
\n
\n Avoid including multiple entries with the same statCode but different updateStrategy values.\n
\n
\n To apply multiple operations on the same stat, please batch or sequence them in separate requests, according to your business logic.\n
\n\n \u274c Incorrect Example:\n\n [\n {\n \"statCode\": \"exp\",\n \"updateStrategy\": \"OVERRIDE\",\n \"value\": 10\n },\n {\n \"statCode\": \"exp\",\n \"updateStrategy\": \"INCREMENT\",\n \"value\": 50\n }\n ]\n\n \u2705 Correct Example:\n\n [\n {\n \"statCode\": \"exp\",\n \"updateStrategy\": \"OVERRIDE\",\n \"value\": 10\n }.\n {\n \"statCode\": \"headshot\",\n \"updateStrategy\": \"INCREMENT\",\n \"value\": 10\n }\n ]\n
\n\n\n",
"operationId": "bulkUpdateUserStatItem_2",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"items": {
"$ref": "#/definitions/BulkStatItemUpdate"
},
"type": "array"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"items": {
"$ref": "#/definitions/BulkStatOperationResult"
},
"type": "array"
}
},
"400": {
"description": "Bad request",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public bulk update user's statitems value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v2/bulk-update"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"20001": "unauthorized access",
"20013": "insufficient permission",
"20002": "validation error",
"20000": "Internal server error"
}
}
},
"/v2/public/namespaces/{namespace}/users/{userId}/stats/{statCode}/statitems/value": {
"put": {
"consumes": [
"application/json"
],
"description": "Public update user's statitem value for a given namespace and user with a certain update strategy. \nThere are four supported update strategies:\n+ *OVERRIDE*: update user statitem with the new value\n+ *INCREMENT*: increment user statitem with the specified value\n+ *MAX*: update user statitem with the specified value if it's larger than the existing value\n+ *MIN*: update user statitem with the specified value if it's lower than the existing value\n\nThe *additionalKey* parameter will be suffixed to *userId* and is used to support multi level user's statitems, such as character's statitems. \nIf provided, user's statitems will be saved with key: *userId_additionalKey* \n\nOther detail info:\n+ *Returns*: updated user's statItem",
"operationId": "updateUserStatItemValue_1",
"parameters": [
{
"in": "body",
"name": "body",
"required": true,
"schema": {
"$ref": "#/definitions/StatItemUpdate"
}
},
{
"description": "namespace",
"in": "path",
"name": "namespace",
"required": true,
"type": "string"
},
{
"description": "stat code",
"in": "path",
"name": "statCode",
"required": true,
"type": "string"
},
{
"description": "user ID",
"in": "path",
"name": "userId",
"required": true,
"type": "string"
},
{
"description": "additional key",
"in": "query",
"name": "additionalKey",
"required": false,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "successful operation",
"schema": {
"$ref": "#/definitions/StatItemIncResult"
}
},
"400": {
"description": "| errorCode | errorMessage |
| 12221 | Invalid stat operator, expect [{expected}] but actual [{actual}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"401": {
"description": "| ErrorCode | ErrorMessage |
| 20001 | unauthorized access |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"403": {
"description": "| ErrorCode | ErrorMessage |
| 20013 | insufficient permission |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"404": {
"description": "| errorCode | errorMessage |
| 12241 | Stat [{statCode}] cannot be found in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"409": {
"description": "| ErrorCode | ErrorMessage |
| 12273 | Stat [{statCode}] is not decreasable |
| 12275 | [{action}] value: [{value}] of stat [{statCode}] is out of range while minimum [{minimum}] and maximum [{maximum}] in namespace [{namespace}] |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
},
"422": {
"description": "| errorCode | errorMessage |
| 20002 | validation error |
",
"schema": {
"$ref": "#/definitions/ValidationErrorEntity"
}
},
"500": {
"description": "| ErrorCode | ErrorMessage |
| 20000 | Internal server error |
",
"schema": {
"$ref": "#/definitions/ErrorEntity"
}
}
},
"security": [
{
"authorization": []
}
],
"summary": "Public update user's statitem value",
"tags": [
"UserStatistic"
],
"x-operationId": {
"value": "social/public/user-stat-values/v2/update"
},
"x-security": {
"userPermissions": "NAMESPACE:{namespace}:USER:{userId}:STATITEM [UPDATE]"
},
"x-errorCodes": {
"12221": "Invalid stat operator, expect [{expected}] but actual [{actual}]",
"20001": "unauthorized access",
"20013": "insufficient permission",
"12241": "Stat [{statCode}] cannot be found in namespace [{namespace}]",
"12273": "Stat [{statCode}] is not decreasable",
"12275": "[{action}] value: [{value}] of stat [{statCode}] is out of range while minimum [{minimum}] and maximum [{maximum}] in namespace [{namespace}]",
"20002": "validation error",
"20000": "Internal server error"
}
}
}
},
"securityDefinitions": {
"authorization": {
"in": "header",
"name": "Authorization",
"type": "apiKey"
}
},
"swagger": "2.0",
"tags": [
{
"name": "GameProfile (Deprecated)"
},
{
"name": "GlobalStatistic"
},
{
"name": "Slot (Deprecated)"
},
{
"name": "SlotConfig (Deprecated)"
},
{
"name": "StatConfiguration"
},
{
"name": "StatCycleConfiguration"
},
{
"name": "UserStatistic"
},
{
"name": "UserStatisticCycle"
}
],
"x-docs": {
"alias": "social",
"host": "https://stage.accelbyte.io",
"path": "/social/swagger.json"
},
"x-version": {
"buildBy": "Gradle 8.5",
"buildDate": "2026-07-03T02:30:56+00:00",
"buildID": "4.5.2",
"buildJDK": "21.0.6 (Amazon.com Inc. 21.0.6+7-LTS)",
"buildOS": "Linux amd64 6.1.144-170.251.amzn2023.x86_64",
"gitBranchName": "release-candidate",
"gitHash": "f877a98e2c",
"gitTag": "4.5.2",
"name": "justice-social-service",
"realm": "staging",
"version": "4.5.2",
"version-roles-seeding": "0.0.12"
}
}