Enrichments

6 operations in the Adverity Connect API. Replace {{INSTANCE}} and {{KEY}} in the examples with your instance and API key. How authentication works.

List transformer

GET/api/transformer/

API key permissionTransformation: Read-onlytransformation:read

Query parameters

orderingstring
Which field to use when ordering the results.
pageinteger
A page number within the paginated result set.
page_sizeinteger
Number of results to return per page.
stack_idinteger
Scope the result to this workspace's family. When omitted, every accessible workspace is returned. A non-numeric value is rejected with a 400.

Responses

200OKapplication/json

Response schema

object PaginatedTransformerBasicList

countintegerrequired
Example 123
nextstring · urinullable
Example "http://api.example.org/accounts/?page=4"
previousstring · urinullable
Example "http://api.example.org/accounts/?page=2"
resultsarray of objectrequired
Items · TransformerBasic
- idintegerrequiredread-only
- namestringrequired
  Max length 200
- stackintegernullable
- change_urlstringrequiredread-onlynullable

Create transformer

POST/api/transformer/

API key permissionTransformation: Writetransformation:write

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object TransformerFull

namestringrequired
Max length 200
stackintegernullable
instructionsany

Responses

201Createdapplication/json

Response schema

object TransformerFull

idintegerrequiredread-only
namestringrequired
Max length 200
stackintegernullable
change_urlstringrequiredread-onlynullable
instructionsany

Get transformer

GET/api/transformer/{id}/

API key permissionTransformation: Read-onlytransformation:read

Path parameters

idintegerrequired
A unique integer value identifying this Transformer Configuration.

Responses

200OKapplication/json

Response schema

object TransformerFull

idintegerrequiredread-only
namestringrequired
Max length 200
stackintegernullable
change_urlstringrequiredread-onlynullable
instructionsany

Replace transformer

PUT/api/transformer/{id}/

API key permissionTransformation: Writetransformation:write

Path parameters

idintegerrequired
A unique integer value identifying this Transformer Configuration.

Request bodyrequired

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object TransformerFull

namestringrequired
Max length 200
stackintegernullable
instructionsany

Responses

200OKapplication/json

Response schema

object TransformerFull

idintegerrequiredread-only
namestringrequired
Max length 200
stackintegernullable
change_urlstringrequiredread-onlynullable
instructionsany

Update transformer

PATCH/api/transformer/{id}/

API key permissionTransformation: Writetransformation:write

Path parameters

idintegerrequired
A unique integer value identifying this Transformer Configuration.

Request body

application/json also application/x-www-form-urlencoded, multipart/form-data

Body schema

object PatchedTransformerPartialUpdate

namestring
Max length 200
descriptionstring
Max length 1000
instructionsany

Responses

200OKapplication/json

Response schema

object TransformerPartialUpdate

idintegerrequiredread-only
namestringrequired
Max length 200
descriptionstring
Max length 1000
instructionsany

Delete transformer

DELETE/api/transformer/{id}/

API key permissionTransformation: Writetransformation:write

Path parameters

idintegerrequired
A unique integer value identifying this Transformer Configuration.

Responses

204No response body