POST /{id}/labels

Edits an application's labels.

Resource Name: /applications/{id}/labels

Permissions Required:
  • editAllApplications
  • createLabels
Request URL Parameters:

Parameter

Type

Description
idMandatory

String

The application's revision ID.
addLabels

Array of String

List of labels that the user would like to add to the application revision.
removeLabels

Array of String

List of label names that the user would like to remove from application revision.

Return:

Parameter

Type

Description
applicationId

Integer

Edited application's ID.
labels

Array of String

List of all application label names.
Error Codes:
  • 404 (Not found) - Application wasn't found.
  • 403 (Forbidden) - User doesn't have permission to edit the application.
  • 403 (Forbidden) - User doesn't have permission to edit the application's general information.
  • 403 (Forbidden) - User doesn't have permission to add new labels when addLabels request field has unknown labels.
  • 400 (Bad request) - User is trying to add system label to application or validation failure.

Request example: 

POST <ip:port>/BusinessFlow/rest/v1/application/15/labels
{
  "addLabels": [
    "label1",
    "label2"
  ],
  "removeLabels": [
    "label3"
  ]
}

Return Example:

{  "applicationId": 15,  "labels": [    "label1",    "label2"  ]}

 

â See also: