Account

Get Account data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}

POST /Account

Create Account
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}
Edit Account
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}
Get list of Accounts
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "type": "string",
            "industry": "string",
            "sicCode": "string",
            "billingAddressStreet": "string",
            "billingAddressCity": "string",
            "billingAddressState": "string",
            "billingAddressCountry": "string",
            "billingAddressPostalCode": "string",
            "shippingAddressStreet": "string",
            "shippingAddressCity": "string",
            "shippingAddressState": "string",
            "shippingAddressCountry": "string",
            "shippingAddressPostalCode": "string",
            "description": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "ownerUserId": "string"
        }
    ]
}
Get linked entities for Account
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Account
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Account data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Account data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Account
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Account
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Account stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Account stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Accounts
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Account
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "type": "string",
    "industry": "string",
    "sicCode": "string",
    "billingAddressStreet": "string",
    "billingAddressCity": "string",
    "billingAddressState": "string",
    "billingAddressCountry": "string",
    "billingAddressPostalCode": "string",
    "shippingAddressStreet": "string",
    "shippingAddressCity": "string",
    "shippingAddressState": "string",
    "shippingAddressCountry": "string",
    "shippingAddressPostalCode": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "ownerUserId": "string"
}
Mass follow to Account entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Account entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Asset

Get Asset data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Asset

Create Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Edit Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

GET /Asset

Get list of Assets
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "height": "int",
            "width": "int",
            "colorSpace": "string",
            "colorDepth": "string",
            "orientation": "string",
            "isActive": "bool",
            "libraryId": "string",
            "name": "string",
            "description": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "private": "bool",
            "type": "string",
            "sizeUnit": "string",
            "ownerUserId": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}
Get linked entities for Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Asset data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Asset data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Asset stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Asset stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Assets
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Asset
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "height": "int",
    "width": "int",
    "colorSpace": "string",
    "colorDepth": "string",
    "orientation": "string",
    "isActive": "bool",
    "libraryId": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "private": "bool",
    "type": "string",
    "sizeUnit": "string",
    "ownerUserId": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Mass follow to Asset entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Asset entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

AssetCategory

Get AssetCategory data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}
Create AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}
Edit AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}
Get list of AssetCategorys
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "categoryRoute": "string",
            "categoryRouteName": "string",
            "name": "string",
            "description": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "code": "string",
            "isActive": "bool",
            "hasChild": "bool",
            "categoryParentId": "string",
            "ownerUserId": "string"
        }
    ]
}
Get linked entities for AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of AssetCategory data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of AssetCategory data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the AssetCategory stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the AssetCategory stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge AssetCategorys
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from AssetCategory
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "code": "string",
    "isActive": "bool",
    "hasChild": "bool",
    "categoryParentId": "string",
    "ownerUserId": "string"
}
Mass follow to AssetCategory entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from AssetCategory entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

AssetMetaData

Get list of AssetMetaDatas
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "value": "string",
            "assetId": "string",
            "ownerUserId": "string"
        }
    ]
}
Get AssetMetaData data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}
Create AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}
Edit AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}
Get linked entities for AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of AssetMetaData data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of AssetMetaData data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the AssetMetaData stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the AssetMetaData stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge AssetMetaDatas
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from AssetMetaData
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "value": "string",
    "assetId": "string",
    "ownerUserId": "string"
}
Mass follow to AssetMetaData entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from AssetMetaData entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

AssetType

Create AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}
Edit AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}
Delete AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of AssetType data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of AssetType data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Get AssetType data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}
Get list of AssetTypes
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "createdById": "string",
            "modifiedById": "string"
        }
    ]
}
Get linked entities for AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Follow the AssetType stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the AssetType stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge AssetTypes
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from AssetType
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string"
}
Mass follow to AssetType entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from AssetType entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

AssociatedProduct

Get AssociatedProduct data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}
Create AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}
Edit AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}
Get list of AssociatedProducts
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "associationId": "string",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "mainProductId": "string",
            "relatedProductId": "string",
            "bothDirections": "bool",
            "backwardAssociationId": "string"
        }
    ]
}
Get linked entities for AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of AssociatedProduct data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of AssociatedProduct data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the AssociatedProduct stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the AssociatedProduct stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge AssociatedProducts
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from AssociatedProduct
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "associationId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "mainProductId": "string",
    "relatedProductId": "string",
    "bothDirections": "bool",
    "backwardAssociationId": "string"
}
Mass follow to AssociatedProduct entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from AssociatedProduct entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Association

Get Association data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Create Association
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Edit Association
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Get list of Associations
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "code": "string",
            "description": "string",
            "isActive": "bool",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "backwardAssociationId": "string",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}
Get linked entities for Association
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Association
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Association data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Association data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Association
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Association
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Association stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Association stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Associations
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Association
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "backwardAssociationId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Mass follow to Association entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Association entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Attachment

Get Attachment data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}
Create Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}
Edit Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}
Get list of Attachments
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "type": "string",
            "size": "float",
            "sourceId": "string",
            "field": "string",
            "createdById": "string",
            "role": "string",
            "storage": "string",
            "storageFilePath": "string",
            "storageThumbPath": "string",
            "global": "bool",
            "md5": "string"
        }
    ]
}
Get linked entities for Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Attachment data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Attachment data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Attachment stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Attachment stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Attachments
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Attachment
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "type": "string",
    "size": "float",
    "sourceId": "string",
    "field": "string",
    "createdById": "string",
    "role": "string",
    "storage": "string",
    "storageFilePath": "string",
    "storageThumbPath": "string",
    "global": "bool",
    "md5": "string"
}
Mass follow to Attachment entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Attachment entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Attribute

Get Attribute data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}
Create Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}
Edit Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}
Get list of Attributes
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "attributeGroupId": "string",
            "code": "string",
            "type": "string",
            "assetType": "string",
            "isMultilang": "bool",
            "typeValue": "array",
            "isSystem": "bool",
            "sortOrder": "int",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "ownerUserDeDeId": "string",
            "ownerUserEnUsId": "string",
            "assignedUserDeDeId": "string",
            "assignedUserEnUsId": "string",
            "typeValueDeDe": "array",
            "typeValueEnUs": "array"
        }
    ]
}
Get linked entities for Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Attribute data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Attribute data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Attribute stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Attribute stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Attributes
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Attribute
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "attributeGroupId": "string",
    "code": "string",
    "type": "string",
    "assetType": "string",
    "isMultilang": "bool",
    "typeValue": "array",
    "isSystem": "bool",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "ownerUserDeDeId": "string",
    "ownerUserEnUsId": "string",
    "assignedUserDeDeId": "string",
    "assignedUserEnUsId": "string",
    "typeValueDeDe": "array",
    "typeValueEnUs": "array"
}
Mass follow to Attribute entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Attribute entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

AttributeGroup

Get AttributeGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Create AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Edit AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Get list of AttributeGroups
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "code": "string",
            "isActive": "bool",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "sortOrder": "int",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}
Get linked entities for AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of AttributeGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of AttributeGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the AttributeGroup stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the AttributeGroup stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge AttributeGroups
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from AttributeGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Mass follow to AttributeGroup entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from AttributeGroup entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

AuthLogRecord

Edit AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}
Mass update of AuthLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}
Create link for AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Get AuthLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}
Get list of AuthLogRecords
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "username": "string",
            "portalId": "string",
            "userId": "string",
            "authTokenId": "string",
            "ipAddress": "string",
            "isDenied": "bool",
            "denialReason": "string",
            "requestTime": "float",
            "requestUrl": "string",
            "requestMethod": "string"
        }
    ]
}
Get linked entities for AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass delete of AuthLogRecord data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Follow the AuthLogRecord stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the AuthLogRecord stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge AuthLogRecords
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from AuthLogRecord
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "username": "string",
    "portalId": "string",
    "userId": "string",
    "authTokenId": "string",
    "ipAddress": "string",
    "isDenied": "bool",
    "denialReason": "string",
    "requestTime": "float",
    "requestUrl": "string",
    "requestMethod": "string"
}
Mass follow to AuthLogRecord entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from AuthLogRecord entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

AuthToken

Edit AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool",
    "lifetime": "int",
    "idleTime": "int"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool",
    "lifetime": "int",
    "idleTime": "int"
}
Mass update of AuthToken data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool",
    "lifetime": "int",
    "idleTime": "int"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool",
    "lifetime": "int",
    "idleTime": "int"
}
Create link for AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Get AuthToken data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool",
    "lifetime": "int",
    "idleTime": "int"
}
Get list of AuthTokens
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "token": "string",
            "hash": "string",
            "userId": "string",
            "portalId": "string",
            "ipAddress": "string",
            "isActive": "bool",
            "lifetime": "int",
            "idleTime": "int"
        }
    ]
}
Get linked entities for AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass delete of AuthToken data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Follow the AuthToken stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the AuthToken stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge AuthTokens
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from AuthToken
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "token": "string",
    "hash": "string",
    "userId": "string",
    "portalId": "string",
    "ipAddress": "string",
    "isActive": "bool",
    "lifetime": "int",
    "idleTime": "int"
}
Mass follow to AuthToken entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from AuthToken entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Brand

Get Brand data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Brand

Create Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Edit Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

GET /Brand

Get list of Brands
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "isActive": "bool",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "code": "string",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}
Get linked entities for Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Brand data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Brand data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Brand stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Brand stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Brands
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Brand
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Mass follow to Brand entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Brand entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Catalog

Get Catalog data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Catalog

Create Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Edit Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Get list of Catalogs
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "code": "string",
            "description": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "isActive": "bool",
            "ownerUserId": "string",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}
Get linked entities for Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Catalog data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Catalog data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Catalog stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Catalog stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Catalogs
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Catalog
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "code": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "isActive": "bool",
    "ownerUserId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Mass follow to Catalog entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Catalog entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Category

Get Category data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Create Category
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Edit Category
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Get list of Categorys
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "code": "string",
            "isActive": "bool",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "sortOrder": "int",
            "categoryParentId": "string",
            "categoryRoute": "string",
            "categoryRouteName": "string",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}
Get linked entities for Category
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Category
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Category data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Category data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Category
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Category
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Category stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Category stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Categorys
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Category
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "code": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "sortOrder": "int",
    "categoryParentId": "string",
    "categoryRoute": "string",
    "categoryRouteName": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Mass follow to Category entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Category entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Channel

Get Channel data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}

POST /Channel

Create Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Edit Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Get list of Channels
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "isActive": "bool",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "code": "string",
            "categoryId": "string",
            "nameDeDe": "string",
            "nameEnUs": "string",
            "descriptionDeDe": "string",
            "descriptionEnUs": "string"
        }
    ]
}
Get linked entities for Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Channel data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Channel data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Channel stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Channel stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Channels
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Channel
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "isActive": "bool",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "code": "string",
    "categoryId": "string",
    "nameDeDe": "string",
    "nameEnUs": "string",
    "descriptionDeDe": "string",
    "descriptionEnUs": "string"
}
Mass follow to Channel entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Channel entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Composer

Call composer update command
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Cancel changes
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Get modules
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": 1,
    "list": [
        {
            "id": "Revisions",
            "name": "Revisions",
            "version": "1.0.0",
            "description": "Module Revisions.",
            "required": [],
            "isActive": true
        }
    ]
}
Install module
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
null
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Update module version
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "Erp",
    "version": "1.1.0"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Delete module
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "Erp"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Cancel module changes
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "Erp"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get composer stream data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": "array"
}

Contact

Get Contact data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}

POST /Contact

Create Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}
Edit Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}
Get list of Contacts
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "salutationName": "string",
            "firstName": "string",
            "lastName": "string",
            "accountId": "string",
            "description": "string",
            "doNotCall": "bool",
            "addressStreet": "string",
            "addressCity": "string",
            "addressState": "string",
            "addressCountry": "string",
            "addressPostalCode": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string"
        }
    ]
}
Get linked entities for Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Contact data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Contact data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Contact stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Contact stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Contacts
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Contact
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "salutationName": "string",
    "firstName": "string",
    "lastName": "string",
    "accountId": "string",
    "description": "string",
    "doNotCall": "bool",
    "addressStreet": "string",
    "addressCity": "string",
    "addressState": "string",
    "addressCountry": "string",
    "addressPostalCode": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string"
}
Mass follow to Contact entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Contact entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Content

Get Content data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}

POST /Content

Create Content
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Edit Content
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Get list of Contents
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "status": "string",
            "type": "string",
            "description": "string",
            "text": "string",
            "metaTitle": "string",
            "metaDescription": "string",
            "contentGroupId": "string",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string"
        }
    ]
}
Get linked entities for Content
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete Content
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of Content data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of Content data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for Content
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from Content
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the Content stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the Content stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge Contents
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from Content
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "status": "string",
    "type": "string",
    "description": "string",
    "text": "string",
    "metaTitle": "string",
    "metaDescription": "string",
    "contentGroupId": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Mass follow to Content entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from Content entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

ContentGroup

Get ContentGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Create ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Edit ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Get list of ContentGroups
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string"
        }
    ]
}
Get linked entities for ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of ContentGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of ContentGroup data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the ContentGroup stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the ContentGroup stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge ContentGroups
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from ContentGroup
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string"
}
Mass follow to ContentGroup entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from ContentGroup entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

DamConfig

Get DamConfig data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
[]
Create DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
[]
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
[]
Edit DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
[]
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
[]
Get list of DamConfigs
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        []
    ]
}
Get linked entities for DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of DamConfig data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of DamConfig data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the DamConfig stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the DamConfig stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge DamConfigs
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from DamConfig
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
[]
Mass follow to DamConfig entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from DamConfig entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

Dashlet

Get Dashlet data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
dashletName string Dashlet name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
[
    {
        "total": "integer",
        "list": "array"
    }
]

ExportFeed

Export data to file
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
exportFeedId string ExportFeed ID Yes
Body
{
    "id": "1"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
null
Export channel data to file
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
channelId string Channel ID Yes
Body
{
    "id": "1"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
null
Get ExportFeed data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "type": "string",
    "isActive": "bool",
    "fileType": "string",
    "isFileHeaderRow": "bool",
    "csvFieldDelimiter": "string",
    "csvTextQualifier": "string",
    "data": "json"
}
Create ExportFeed
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "type": "string",
    "isActive": "bool",
    "fileType": "string",
    "isFileHeaderRow": "bool",
    "csvFieldDelimiter": "string",
    "csvTextQualifier": "string",
    "data": "json"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "type": "string",
    "isActive": "bool",
    "fileType": "string",
    "isFileHeaderRow": "bool",
    "csvFieldDelimiter": "string",
    "csvTextQualifier": "string",
    "data": "json"
}
Edit ExportFeed
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "type": "string",
    "isActive": "bool",
    "fileType": "string",
    "isFileHeaderRow": "bool",
    "csvFieldDelimiter": "string",
    "csvTextQualifier": "string",
    "data": "json"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "type": "string",
    "isActive": "bool",
    "fileType": "string",
    "isFileHeaderRow": "bool",
    "csvFieldDelimiter": "string",
    "csvTextQualifier": "string",
    "data": "json"
}
Get list of ExportFeeds
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "description": "string",
            "createdById": "string",
            "modifiedById": "string",
            "ownerUserId": "string",
            "assignedUserId": "string",
            "type": "string",
            "isActive": "bool",
            "fileType": "string",
            "isFileHeaderRow": "bool",
            "csvFieldDelimiter": "string",
            "csvTextQualifier": "string",
            "data": "json"
        }
    ]
}
Get linked entities for ExportFeed
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "integer",
    "list": "array"
}
Delete ExportFeed
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
true
Mass update of ExportFeed data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
attributes json Json of attributes and attributes value Yes
ids array Array of ids Yes
Body
{
    "attributes": "json",
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Mass delete of ExportFeed data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "count": "integer",
    "ids": "array"
}
Create link for ExportFeed
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Remove link from ExportFeed
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
link string Link name Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Follow the ExportFeed stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Unfollow the ExportFeed stream
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId string Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
"bool"
Merge ExportFeeds
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "attributes": "json",
    "targetId": "string",
    "sourceIds": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
"bool"
Get duplicate attributes from ExportFeed
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "id": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "description": "string",
    "createdById": "string",
    "modifiedById": "string",
    "ownerUserId": "string",
    "assignedUserId": "string",
    "type": "string",
    "isActive": "bool",
    "fileType": "string",
    "isFileHeaderRow": "bool",
    "csvFieldDelimiter": "string",
    "csvTextQualifier": "string",
    "data": "json"
}
Mass follow to ExportFeed entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}
Mass unfollow from ExportFeed entities
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "ids": "array"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "ids": "array",
    "count": "integer"
}

ExportResult

Get ExportResult data
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "id": "string",
    "deleted": "bool",
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "channelId": "string",
    "exportFeedId": "string",
    "state": "string",
    "stateMessage": "string",
    "ownerUserId": "string"
}
Create ExportResult
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "channelId": "string",
    "exportFeedId": "string",
    "state": "string",
    "stateMessage": "string",
    "ownerUserId": "string"
}
Status Codes
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "channelId": "string",
    "exportFeedId": "string",
    "state": "string",
    "stateMessage": "string",
    "ownerUserId": "string"
}
Edit ExportResult
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
entityId integer Entity id Yes
Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "channelId": "string",
    "exportFeedId": "string",
    "state": "string",
    "stateMessage": "string",
    "ownerUserId": "string"
}
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "name": "string",
    "createdById": "string",
    "modifiedById": "string",
    "assignedUserId": "string",
    "channelId": "string",
    "exportFeedId": "string",
    "state": "string",
    "stateMessage": "string",
    "ownerUserId": "string"
}
Get list of ExportResults
Headers
Key Value
Accept application/json
Content-Type application/json
Basic-Authorization HASH
Parameters
Parameter Type Description Required
maxSize integer Max size for paging No
offset integer Offset for paging No
sortBy string Sort column No
asc bool Sort order No
Status Codes
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Body
{
    "total": "int",
    "list": [
        {
            "id": "string",
            "deleted": "bool",
            "name": "string",
            "createdById": "string",
            "modifiedById": "string",
            "assignedUserId": "string",
            "channelId": "string",
            "exportFeedId": "string",
            "state":