OnAutomate API V1.1.1
Welcome to onautomate Api docs.
Custom Value
GET /v1/custom-values/
https://link.amtssl.com/v1/custom-values/
Get all available custom values.
Authorization:
Provide your location api key (Bearer Token).
AUTHORIZATION
Bearer Token
Token
<token>
Example Request
curl --location --request GET 'https://link.amtssl.com/v1/custom-values/' \
--header 'Authorization: Bearer <token>'
Example Response
Successful Response
Bad Request. please contact support!
Unauthorized
200 OK
{
"customFields": [
{
"id": "ocQHyuzHvysMo5N5VsXc",
"name": "Select",
"fieldKey": "",
"value": "test"
},
{
"id": "ocQHyuzHvysMo5N5VsXc",
"name": "Select",
"fieldKey": "",
"value": "test"
}
]
}
200 OK
{
"msg": "Bad Request"
}
401 Unauthorized
{
"msg": "Unauthorized"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
POST /v1/custom-values/
https://link.amtssl.com/v1/custom-values/
AUTHORIZATION
Bearer Token
Token
<token>
HEADERS
Content-Type
application/json
BODY raw
{
"name": "Custom Field",
"value": "Value"
}
Example Request
curl --location --request POST 'https://link.amtssl.com/v1/custom-values/' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"name": "Custom Field",
"value": "Value"
}'
Example Response
Bad Request. please contact support!
Successful Response
Unauthorized
Unprocessable Entity
400 Bad Request
{
"msg": "Bad Request"
}
200 OK
{
"id": "ocQHyuzHvysMo5N5VsXc",
"name": "Select",
"fieldKey": "",
"value": "test"
}
401 Unauthorized
{
"msg": "Unauthorized"
}
422 Unprocessable Entity (WebDAV) (RFC 4918)
{
"name": {
"message": "The name field is mandatory.",
"rule": "required"
},
"value": {
"message": "The value field is mandatory.",
"rule": "required"
}
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
GET /v1/custom-values/:customValueId
https://link.amtssl.com/v1/custom-values/:customValueId
AUTHORIZATION
Bearer Token
Token
<token>
PATH VARIABLES
customValueId
ocQHyuzHvysMo5N5VsXc
(Required) Custom Value Id
Example Request
curl --location --request GET 'https://link.amtssl.com/v1/custom-values/:customValueId' \
--header 'Authorization: Bearer <token>'
Example Response
Bad Request. please contact support!
Unauthorized
Successful response
400 Bad Request
BODY
{
"msg": "Bad Request"
}
401 Unauthorized
BODY
{
"msg": "Bad Request"
}
200 OK
BODY
{
"msg": "Bad Request"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
POST /v1/custom-values/:customValueId
https://link.amtssl.com/v1/custom-values/:customValueId
AUTHORIZATION
Bearer Token
Token
<token>
HEADERS
Content-Type
application/json
PATH VARIABLES
customValueId
ocQHyuzHvysMo5N5VsXc
(Required) Custom Value Id
BODY raw
{
"name": "Custom Field",
"value": "Value"
}
Example Request
curl --location --request PUT 'https://link.amtssl.com/v1/custom-values/:customValueId' \
--header 'Authorization: Bearer <token>' \
--data-raw '{
"name": "Custom Field",
"value": "Value"
}'
Example Response
Successful response
Unprocessable Entity
Bad Request. please contact support!
Unauthorized
200 OK
BODY
{
"id": "ocQHyuzHvysMo5N5VsXc",
"name": "Select",
"fieldKey": "",
"value": "test"
}
422 Unprocessable Entity (WebDAV) (RFC 4918)
BODY
{
"name": {
"message": "The name field is mandatory.",
"rule": "required"
},
"value": {
"message": "The value field is mandatory.",
"rule": "required"
}
}
400 Bad Request
BODY
{
"msg": "Bad Request"
}
401 Unauthorized
BODY
{
"msg": "Unauthorized"
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
DEL /v1/custom-values/:customValueId
https://link.amtssl.com/v1/custom-values/:customValueId
Delete one of custom value.
Authorization:
Provide your location api key (Bearer Token).
AUTHORIZATION
Bearer Token
Token
<token>
PATH VARIABLES
customValueId
ocQHyuzHvysMo5N5VsXc
(Required) Custom Value Id
Example Request
curl --location --request DELETE 'https://link.amtssl.com/v1/custom-values/:customValueId' \
--header 'Authorization: Bearer <token>'
Example Response
Bad Request. please contact support!
Unauthorized
Successful response
Unprocessable Entity
400 Bad Request
BODY
{
"msg": "Bad Request"
}
401 Unauthorized
BODY
{
"msg": "Unauthorized"
}
200 OK
BODY
""
422 Unprocessable Entity (WebDAV) (RFC 4918)
BODY
{
"customValueId": {
"message": "The custom field id is invalid.",
"rule": "invalid"
}
}
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json
Headers
Content-Type: application/json