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-only
  • smart_naming_conventionobjectrequiredread-only
    Attributes · SmartNamingConventionSummary

    • idintegerrequiredread-only
    • column_namestringrequiredread-only
    • datastream_namesstringrequiredread-only
    • delimiters_charactersstringrequiredread-only
    • sorted_columns_namesstringrequiredread-only
    • email_for_errorbooleanrequired
    • email_for_warningbooleanrequired
    • raise_for_warningbooleanrequired
    • add_status_columnsbooleanrequired
    • columns_rule_phrasingstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/transformer/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "id": 1,
      "name": "string",
      "stack": 1,
      "change_url": "string",
      "smart_naming_convention": {
        "id": 1,
        "column_name": "string",
        "datastream_names": "string",
        "delimiters_characters": "string",
        "sorted_columns_names": "string",
        "email_for_error": true,
        "email_for_warning": true,
        "raise_for_warning": true,
        "add_status_columns": true,
        "columns_rule_phrasing": "string"
      }
    }
  ]
}

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-only
• instructionsany

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/transformer/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string",
    "stack": 1,
    "instructions": null
  }'

Response201

{
  "id": 1,
  "name": "string",
  "stack": 1,
  "change_url": "string",
  "instructions": null
}

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-only
• instructionsany

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/transformer/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "name": "string",
  "stack": 1,
  "change_url": "string",
  "instructions": null
}

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-only
• instructionsany

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/transformer/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string",
    "stack": 1,
    "instructions": null
  }'

Response200

{
  "id": 1,
  "name": "string",
  "stack": 1,
  "change_url": "string",
  "instructions": null
}

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

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/transformer/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string",
    "description": "string",
    "instructions": null
  }'

Response200

{
  "id": 1,
  "name": "string",
  "description": "string",
  "instructions": null
}

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

RequestcURL

curl --request DELETE 'https://{{INSTANCE}}/api/transformer/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response204

No response body.

Was this page helpful? Yes No