POST /{id}/custom_fields

Edits an application's custom fields.

Resource Name: /applications/{id}/custom_fields

Permissions Required:
  • editAllApplications
Request URL Parameters:

Parameter

Type

Description
idMandatory

String

The application's revision ID.

setCustomFields

Array of KeyValuePair (see KeyValuePair )

List of custom fields that the user would like to add to the application revision.

clearCustomFields

Array of String

List of custom field names to clear from the application.

Return:

Parameter

Type

Description

applicationId

Integer

Edited application's ID.

customFields

Array of KeyValuePair (see KeyValuePair )

List of all the application's custom fields.
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 general information.
  • 400 (Bad request) - Custom fields do not exist.
  • 400 (Bad request) - Invalid role.

Request example: 

POST <ip:port>/BusinessFlow/rest/v1/application/15/custom_fields
{
  "setCustomFields": [
    {
      "name": "customField1",
      "value": "value1" 
    }
  ],
  "clearCustomFields": [
    "customField2"
  ]
}

Return Example:

{  "applicationId": 15,  "customFields": [    {      "name": "customField1",       "value": "value1"    }  ]}

 

â See also: