Get Labels

Get the list of all configured Labels.

URL: /rest-api/label/list.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.

Response sample:

200 OK
[{"id":1,"value":"label1", "defaultLabel": true, "defaultLabelObjectType": 1, "defaultLabelPlacementTypes": [1,4,5]},{"id":2,"value":"valelN", ...}, ... ]

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Get Label by ID

Get the label by its Identifier.

URL: /rest-api/label/{labelId}.do
Method: GET
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not found – Label with such ID doesn't exist.

Response sample:

200 OK
{"id":1,"value":"label1", "defaultLabel": true, "defaultLabelObjectType": 1, "defaultLabelPlacementTypes": [1,4,5]}

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Create Label

Create a new label.

URL: /rest-api/label/create.do
Method: POST

Request format: Method requires request body in JSON format. Depending on the inner-object properties, label will be updated. 'JSON object': {"value":"label1", "defaultLabel": true, "defaultLabelObjectType": 1, "defaultLabelPlacementTypes": [1,4,5]}

Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.

Required headers:

  • Content-Type - application/json
  • Accept - application/json

Response sample:

200 OK

Validation error messages can be returned in scope of response:
{"id":1,"value":"label1", "defaultLabel": true, "defaultLabelObjectType": 1, "defaultLabelPlacementTypes": [1,4,5]}

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Update Label

Create a new label.

URL: /rest-api/label/{labelId}/update.do
Method: POST

Response format: application/json

Request format: Method requires request body in JSON format. Depending on the inner-object properties, label will be updated. 'JSON object': {"value":"label1", "defaultLabel": true, "defaultLabelObjectType": 1, "defaultLabelPlacementTypes": [1,4,5]}

Required headers:

  • Content-Type - application/json
  • Accept - application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not found – Label with such ID doesn't exist.

Response sample:

200 OK

Validation error messages can be returned in scope of response.

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Delete Label

Delete label by its ID.

URL: /rest-api/label/{labelId}/delete.do
Method: DELETE
Response format: application/json

Error codes:

  • 401 Unauthorized – authentication error.
  • 403 Forbidden – not enough permissions.
  • 404 Not found – Label with such ID doesn't exist.

Parameters:

  • hash – an MD5 digest of a concatenated username's MD5 password and a given timestamp.
  • timestamp – UNIX timestamp in milliseconds used in hash generation.
  • username – the given username.

Need more help?

Should you require any additional help with our solutions, do not hesitate to contact Epom technical support at support@epom.com. Our support managers are dedicated to resolving any issues and providing you with solutions and support if you face difficulties or have questions.