Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "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" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "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" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "height": "int", "width": "int", "colorSpace": "string", "colorDepth": "string", "orientation": "string", "isActive": "bool", "libraryId": "string", "path": "string", "name": "string", "description": "string", "metaData": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "private": "bool", "type": "string", "sizeUnit": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "height": "int", "width": "int", "colorSpace": "string", "colorDepth": "string", "orientation": "string", "isActive": "bool", "libraryId": "string", "path": "string", "name": "string", "description": "string", "metaData": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "private": "bool", "type": "string", "sizeUnit": "string", "ownerUserId": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "height": "int", "width": "int", "colorSpace": "string", "colorDepth": "string", "orientation": "string", "isActive": "bool", "libraryId": "string", "path": "string", "name": "string", "description": "string", "metaData": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "private": "bool", "type": "string", "sizeUnit": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "height": "int", "width": "int", "colorSpace": "string", "colorDepth": "string", "orientation": "string", "isActive": "bool", "libraryId": "string", "path": "string", "name": "string", "description": "string", "metaData": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "private": "bool", "type": "string", "sizeUnit": "string", "ownerUserId": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "height": "int", "width": "int", "colorSpace": "string", "colorDepth": "string", "orientation": "string", "isActive": "bool", "libraryId": "string", "path": "string", "name": "string", "description": "string", "metaData": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "private": "bool", "type": "string", "sizeUnit": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": [ { "id": "string", "deleted": "bool", "height": "int", "width": "int", "colorSpace": "string", "colorDepth": "string", "orientation": "string", "isActive": "bool", "libraryId": "string", "path": "string", "name": "string", "description": "string", "metaData": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "private": "bool", "type": "string", "sizeUnit": "string", "ownerUserId": "string" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "height": "int", "width": "int", "colorSpace": "string", "colorDepth": "string", "orientation": "string", "isActive": "bool", "libraryId": "string", "path": "string", "name": "string", "description": "string", "metaData": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "private": "bool", "type": "string", "sizeUnit": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "categoryRoute": "string", "categoryRouteName": "string", "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "code": "string", "isActive": "bool", "hasChild": "bool", "categoryParentId": "string", "ownerUserId": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "categoryRoute": "string", "categoryRouteName": "string", "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "code": "string", "isActive": "bool", "hasChild": "bool", "categoryParentId": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "categoryRoute": "string", "categoryRouteName": "string", "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "code": "string", "isActive": "bool", "hasChild": "bool", "categoryParentId": "string", "ownerUserId": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "categoryRoute": "string", "categoryRouteName": "string", "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "code": "string", "isActive": "bool", "hasChild": "bool", "categoryParentId": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "categoryRoute": "string", "categoryRouteName": "string", "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "code": "string", "isActive": "bool", "hasChild": "bool", "categoryParentId": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": [ { "id": "string", "deleted": "bool", "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "value": "string", "assetId": "string", "ownerUserId": "string" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "value": "string", "assetId": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "value": "string", "assetId": "string", "ownerUserId": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "value": "string", "assetId": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "value": "string", "assetId": "string", "ownerUserId": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "value": "string", "assetId": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "value": "string", "assetId": "string", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "createdById": "string", "modifiedById": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "createdById": "string", "modifiedById": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "createdById": "string", "modifiedById": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "createdById": "string", "modifiedById": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "createdById": "string", "modifiedById": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": [ { "id": "string", "deleted": "bool", "name": "string", "createdById": "string", "modifiedById": "string" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "createdById": "string", "modifiedById": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "associationId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "mainProductId": "string", "relatedProductId": "string", "bothDirections": "bool", "backwardAssociationId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "associationId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "mainProductId": "string", "relatedProductId": "string", "bothDirections": "bool", "backwardAssociationId": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "associationId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "mainProductId": "string", "relatedProductId": "string", "bothDirections": "bool", "backwardAssociationId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "associationId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "mainProductId": "string", "relatedProductId": "string", "bothDirections": "bool", "backwardAssociationId": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "associationId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "mainProductId": "string", "relatedProductId": "string", "bothDirections": "bool", "backwardAssociationId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "associationId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "mainProductId": "string", "relatedProductId": "string", "bothDirections": "bool", "backwardAssociationId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "code": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "backwardAssociationId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "code": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "backwardAssociationId": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "code": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "backwardAssociationId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "code": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "backwardAssociationId": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "code": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "backwardAssociationId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "code": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "backwardAssociationId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "type": "string", "size": "float", "sourceId": "string", "field": "string", "createdById": "string", "role": "string", "storage": "string", "storageFilePath": "string", "storageThumbPath": "string", "global": "bool", "md5": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "type": "string", "size": "float", "sourceId": "string", "field": "string", "createdById": "string", "role": "string", "storage": "string", "storageFilePath": "string", "storageThumbPath": "string", "global": "bool", "md5": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "type": "string", "size": "float", "sourceId": "string", "field": "string", "createdById": "string", "role": "string", "storage": "string", "storageFilePath": "string", "storageThumbPath": "string", "global": "bool", "md5": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "type": "string", "size": "float", "sourceId": "string", "field": "string", "createdById": "string", "role": "string", "storage": "string", "storageFilePath": "string", "storageThumbPath": "string", "global": "bool", "md5": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "type": "string", "size": "float", "sourceId": "string", "field": "string", "createdById": "string", "role": "string", "storage": "string", "storageFilePath": "string", "storageThumbPath": "string", "global": "bool", "md5": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"json"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "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" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "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" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "username": "string", "portalId": "string", "userId": "string", "authTokenId": "string", "ipAddress": "string", "isDenied": "bool", "denialReason": "string", "requestTime": "float", "requestUrl": "string", "requestMethod": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "username": "string", "portalId": "string", "userId": "string", "authTokenId": "string", "ipAddress": "string", "isDenied": "bool", "denialReason": "string", "requestTime": "float", "requestUrl": "string", "requestMethod": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "username": "string", "portalId": "string", "userId": "string", "authTokenId": "string", "ipAddress": "string", "isDenied": "bool", "denialReason": "string", "requestTime": "float", "requestUrl": "string", "requestMethod": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "username": "string", "portalId": "string", "userId": "string", "authTokenId": "string", "ipAddress": "string", "isDenied": "bool", "denialReason": "string", "requestTime": "float", "requestUrl": "string", "requestMethod": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "username": "string", "portalId": "string", "userId": "string", "authTokenId": "string", "ipAddress": "string", "isDenied": "bool", "denialReason": "string", "requestTime": "float", "requestUrl": "string", "requestMethod": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "username": "string", "portalId": "string", "userId": "string", "authTokenId": "string", "ipAddress": "string", "isDenied": "bool", "denialReason": "string", "requestTime": "float", "requestUrl": "string", "requestMethod": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "token": "string", "hash": "string", "userId": "string", "portalId": "string", "ipAddress": "string", "isActive": "bool" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "token": "string", "hash": "string", "userId": "string", "portalId": "string", "ipAddress": "string", "isActive": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "token": "string", "hash": "string", "userId": "string", "portalId": "string", "ipAddress": "string", "isActive": "bool" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "token": "string", "hash": "string", "userId": "string", "portalId": "string", "ipAddress": "string", "isActive": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "token": "string", "hash": "string", "userId": "string", "portalId": "string", "ipAddress": "string", "isActive": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": [ { "id": "string", "deleted": "bool", "token": "string", "hash": "string", "userId": "string", "portalId": "string", "ipAddress": "string", "isActive": "bool" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "token": "string", "hash": "string", "userId": "string", "portalId": "string", "ipAddress": "string", "isActive": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": [ { "id": "string", "deleted": "bool", "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "code": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "isActive": "bool", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "code": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "isActive": "bool", "ownerUserId": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "code": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "isActive": "bool", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "code": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "isActive": "bool", "ownerUserId": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "code": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "isActive": "bool", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": [ { "id": "string", "deleted": "bool", "name": "string", "code": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "isActive": "bool", "ownerUserId": "string" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "code": "string", "description": "string", "createdById": "string", "modifiedById": "string", "assignedUserId": "string", "isActive": "bool", "ownerUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int", "categoryParentId": "string", "categoryRoute": "string", "categoryRouteName": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int", "categoryParentId": "string", "categoryRoute": "string", "categoryRouteName": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int", "categoryParentId": "string", "categoryRoute": "string", "categoryRouteName": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int", "categoryParentId": "string", "categoryRoute": "string", "categoryRouteName": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "description": "string", "code": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "sortOrder": "int", "categoryParentId": "string", "categoryRoute": "string", "categoryRouteName": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
channel_id | string | Channel id | Yes |
product_id | string | Product id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
[ { "productAttributeValueId": "string", "attributeId": "string", "name": "string", "type": "string", "isRequired": "bool", "typeValue": [ "string", "string", "..." ], "typeValueEnUs": [ "string", "string", "..." ], "typeValue other languages ...": [], "value": "array|string", "valueEnUs": "array|string", "value other languages ...": "array|string", "attributeGroupId": "string", "attributeGroupName": "string", "attributeGroupOrder": "int", "isCustom": "bool" } ]
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
channel_id | string | Channel id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
[ { "channelProductId": "string", "productId": "string", "productName": "string", "categories": [ "string - categories name" ], "isActive": "bool", "isEditable": "bool" }, "..." ]
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string", "categoryId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string", "categoryId": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string", "categoryId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string", "categoryId": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string", "categoryId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "description": "string", "isActive": "bool", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "code": "string", "categoryId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": 1, "list": [ { "id": "Revisions", "name": "Revisions", "version": "1.0.0", "description": "Module Revisions.", "required": [], "isActive": true } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
null
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "Erp", "version": "1.1.0" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "Erp" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "Erp" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "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" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "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" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "status": "string", "type": "string", "description": "string", "text": "string", "metaTitle": "string", "metaDescription": "string", "contentGroupId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "status": "string", "type": "string", "description": "string", "text": "string", "metaTitle": "string", "metaDescription": "string", "contentGroupId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "status": "string", "type": "string", "description": "string", "text": "string", "metaTitle": "string", "metaDescription": "string", "contentGroupId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "status": "string", "type": "string", "description": "string", "text": "string", "metaTitle": "string", "metaDescription": "string", "contentGroupId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "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" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "status": "string", "type": "string", "description": "string", "text": "string", "metaTitle": "string", "metaDescription": "string", "contentGroupId": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": [ { "id": "string", "deleted": "bool", "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "isActive": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "isActive": "bool" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "isActive": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "isActive": "bool" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "isActive": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": [ { "id": "string", "deleted": "bool", "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "isActive": "bool" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "createdById": "string", "modifiedById": "string", "ownerUserId": "string", "assignedUserId": "string", "isActive": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
[]
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
[]
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
[]
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
[]
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
[]
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": [ [] ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
true
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
attributes | json | Json of attributes and attributes value | Yes |
ids | array | Array of ids | Yes |
{ "attributes": "json", "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "count": "integer", "ids": "array" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "attributes": "json", "targetId": "string", "sourceIds": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
"bool"
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "id": "string" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
[]
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "ids": "array" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "ids": "array", "count": "integer" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
dashletName | string | Dashlet name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
[ { "total": "integer", "list": "array" } ]
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "id": "string", "deleted": "bool", "name": "string", "fromName": "string", "fromString": "string", "replyToString": "string", "addressNameMap": "json", "isReplied": "bool", "messageId": "string", "messageIdInternal": "string", "fromEmailAddressId": "string", "bodyPlain": "string", "body": "string", "isHtml": "bool", "status": "string", "hasAttachment": "bool", "createdById": "string", "sentById": "string", "modifiedById": "string", "assignedUserId": "string", "repliedId": "string", "isSystem": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
{ "name": "string", "fromName": "string", "fromString": "string", "replyToString": "string", "addressNameMap": "json", "isReplied": "bool", "messageId": "string", "messageIdInternal": "string", "fromEmailAddressId": "string", "bodyPlain": "string", "body": "string", "isHtml": "bool", "status": "string", "hasAttachment": "bool", "createdById": "string", "sentById": "string", "modifiedById": "string", "assignedUserId": "string", "repliedId": "string", "isSystem": "bool" }
201 Created
401 Unauthorized
403 Forbidden
500 Internal Server Error
{ "name": "string", "fromName": "string", "fromString": "string", "replyToString": "string", "addressNameMap": "json", "isReplied": "bool", "messageId": "string", "messageIdInternal": "string", "fromEmailAddressId": "string", "bodyPlain": "string", "body": "string", "isHtml": "bool", "status": "string", "hasAttachment": "bool", "createdById": "string", "sentById": "string", "modifiedById": "string", "assignedUserId": "string", "repliedId": "string", "isSystem": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | integer | Entity id | Yes |
{ "name": "string", "fromName": "string", "fromString": "string", "replyToString": "string", "addressNameMap": "json", "isReplied": "bool", "messageId": "string", "messageIdInternal": "string", "fromEmailAddressId": "string", "bodyPlain": "string", "body": "string", "isHtml": "bool", "status": "string", "hasAttachment": "bool", "createdById": "string", "sentById": "string", "modifiedById": "string", "assignedUserId": "string", "repliedId": "string", "isSystem": "bool" }
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "name": "string", "fromName": "string", "fromString": "string", "replyToString": "string", "addressNameMap": "json", "isReplied": "bool", "messageId": "string", "messageIdInternal": "string", "fromEmailAddressId": "string", "bodyPlain": "string", "body": "string", "isHtml": "bool", "status": "string", "hasAttachment": "bool", "createdById": "string", "sentById": "string", "modifiedById": "string", "assignedUserId": "string", "repliedId": "string", "isSystem": "bool" }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
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 |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "int", "list": [ { "id": "string", "deleted": "bool", "name": "string", "fromName": "string", "fromString": "string", "replyToString": "string", "addressNameMap": "json", "isReplied": "bool", "messageId": "string", "messageIdInternal": "string", "fromEmailAddressId": "string", "bodyPlain": "string", "body": "string", "isHtml": "bool", "status": "string", "hasAttachment": "bool", "createdById": "string", "sentById": "string", "modifiedById": "string", "assignedUserId": "string", "repliedId": "string", "isSystem": "bool" } ] }
Key | Value |
---|---|
Accept | application/json |
Content-Type | application/json |
Espo-Authorization | HASH |
Parameter | Type | Description | Required |
---|---|---|---|
entityId | string | Entity id | Yes |
link | string | Link name | Yes |
200 OK
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error
{ "total": "integer", "list": "array" }
Key | Value |
---|---|
Accept |