GET /acd/api/app_definitions/:id
Show application definition

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.


GET /acd/api/app_definitions
List application definitions

Params

Param name Description
search
optional

filter results

Validations:

  • Must be a String

order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
optional

Page number, starting at 1

Validations:

  • Must be a number.

per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.

Search fields

Field name Type Possible values
location
location_id
name
organization
organization_id

POST /acd/api/app_definitions
Create a application definition

Params

Param name Description
app_definition
required

Validations:

  • Must be a Hash

app_definition[name]
required

Validations:

  • Must be a String

app_definition[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type

app_definition[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type

app_definition[description]
required

Validations:

  • Must be a String

app_definition[services]
required

Validations:

  • Must be a String


DELETE /acd/api/app_definitions/:id
Deletes application definition

Params

Param name Description
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.