Configuration

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

List mapping tables

GET/api/mapping-tables/

API key permissionWorkspace: Read-onlyworkspace:read

Query parameters

• namestring
• 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.

Responses

200OKapplication/json

Response schema

object PaginatedMappingTableList

• 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 · MappingTable

  • idintegerrequiredread-only
  • namestringrequired

    A human readable name.

    Max length 500

  • createdstring · date-timerequiredread-only
  • entriesstring · urirequiredread-only
  • urlstring · urirequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/mapping-tables/' \
  --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",
      "created": "2024-01-01T00:00:00Z",
      "entries": "https://example.com",
      "url": "https://example.com"
    }
  ]
}

Get mapping tables

GET/api/mapping-tables/{id}/

API key permissionWorkspace: Read-onlyworkspace:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Mapping Table.

Responses

200OKapplication/json

Response schema

object MappingTable

• idintegerrequiredread-only
• namestringrequired

  A human readable name.

  Max length 500

• createdstring · date-timerequiredread-only
• entriesstring · urirequiredread-only
• urlstring · urirequiredread-only

RequestcURL

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

Response200

{
  "id": 1,
  "name": "string",
  "created": "2024-01-01T00:00:00Z",
  "entries": "https://example.com",
  "url": "https://example.com"
}

Replace mapping tables

PUT/api/mapping-tables/{id}/

API key permissionWorkspace: Writeworkspace:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Mapping Table.

Request bodyrequired

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

Body schema

object MappingTable

• namestringrequired

  A human readable name.

  Max length 500

Responses

200OKapplication/json

Response schema

object MappingTable

• idintegerrequiredread-only
• namestringrequired

  A human readable name.

  Max length 500

• createdstring · date-timerequiredread-only
• entriesstring · urirequiredread-only
• urlstring · urirequiredread-only

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/mapping-tables/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string"
  }'

Response200

{
  "id": 1,
  "name": "string",
  "created": "2024-01-01T00:00:00Z",
  "entries": "https://example.com",
  "url": "https://example.com"
}

Update mapping tables

PATCH/api/mapping-tables/{id}/

API key permissionWorkspace: Writeworkspace:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Mapping Table.

Request body

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

Body schema

object PatchedMappingTablePartialUpdate

• namestring

  A human readable name.

  Max length 500

• descriptionstring

  Max length 1000

Responses

200OKapplication/json

Response schema

object MappingTablePartialUpdate

• idintegerrequiredread-only
• namestringrequired

  A human readable name.

  Max length 500

• descriptionstring

  Max length 1000

RequestcURL

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

Response200

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

List mapping tables entries

GET/api/mapping-tables/{parent_lookup_table_id}/entries/

API key permissionWorkspace: Read-onlyworkspace:read

Path parameters

• parent_lookup_table_idstringrequired

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.

Responses

200OKapplication/json

Response schema

object PaginatedMappingEntryList

• 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 · MappingEntry

  • idintegerrequiredread-only
  • matchstringrequired

    Max length 750

  • valuestring

    Max length 1000

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/mapping-tables/{parent_lookup_table_id}/entries/' \
  --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,
      "match": "string",
      "value": "string"
    }
  ]
}

Create mapping tables entries

POST/api/mapping-tables/{parent_lookup_table_id}/entries/

API key permissionWorkspace: Writeworkspace:write

Path parameters

• parent_lookup_table_idstringrequired

Request bodyrequired

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

Body schema

object MappingEntry

• table_idintegerrequiredwrite-only
• matchstringrequired

  Max length 750

• valuestring

  Max length 1000

Responses

201Createdapplication/json

Response schema

object MappingEntry

• idintegerrequiredread-only
• matchstringrequired

  Max length 750

• valuestring

  Max length 1000

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/mapping-tables/{parent_lookup_table_id}/entries/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "table_id": 1,
    "match": "string",
    "value": "string"
  }'

Response201

{
  "id": 1,
  "match": "string",
  "value": "string"
}

Get mapping tables entries

GET/api/mapping-tables/{parent_lookup_table_id}/entries/{id}/

API key permissionWorkspace: Read-onlyworkspace:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Mapping Entry.

• parent_lookup_table_idstringrequired

Responses

200OKapplication/json

Response schema

object MappingEntry

• idintegerrequiredread-only
• matchstringrequired

  Max length 750

• valuestring

  Max length 1000

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/mapping-tables/{parent_lookup_table_id}/entries/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response200

{
  "id": 1,
  "match": "string",
  "value": "string"
}

Replace mapping tables entries

PUT/api/mapping-tables/{parent_lookup_table_id}/entries/{id}/

API key permissionWorkspace: Writeworkspace:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Mapping Entry.

• parent_lookup_table_idstringrequired

Request bodyrequired

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

Body schema

object MappingEntry

• table_idintegerrequiredwrite-only
• matchstringrequired

  Max length 750

• valuestring

  Max length 1000

Responses

200OKapplication/json

Response schema

object MappingEntry

• idintegerrequiredread-only
• matchstringrequired

  Max length 750

• valuestring

  Max length 1000

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/mapping-tables/{parent_lookup_table_id}/entries/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "table_id": 1,
    "match": "string",
    "value": "string"
  }'

Response200

{
  "id": 1,
  "match": "string",
  "value": "string"
}

Update mapping tables entries

PATCH/api/mapping-tables/{parent_lookup_table_id}/entries/{id}/

API key permissionWorkspace: Writeworkspace:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Mapping Entry.

• parent_lookup_table_idstringrequired

Request body

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

Body schema

object PatchedMappingEntry

• table_idintegerwrite-only
• matchstring

  Max length 750

• valuestring

  Max length 1000

Responses

200OKapplication/json

Response schema

object MappingEntry

• idintegerrequiredread-only
• matchstringrequired

  Max length 750

• valuestring

  Max length 1000

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/mapping-tables/{parent_lookup_table_id}/entries/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "table_id": 1,
    "match": "string",
    "value": "string"
  }'

Response200

{
  "id": 1,
  "match": "string",
  "value": "string"
}

Delete mapping tables entries

DELETE/api/mapping-tables/{parent_lookup_table_id}/entries/{id}/

API key permissionWorkspace: Writeworkspace:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Mapping Entry.

• parent_lookup_table_idstringrequired

Responses

204No response body

RequestcURL

curl --request DELETE 'https://{{INSTANCE}}/api/mapping-tables/{parent_lookup_table_id}/entries/{id}/' \
  --header 'Authorization: Bearer {{KEY}}'

Response204

No response body.

List storage

GET/api/storage/

API key permissionWorkspace: Read-onlyworkspace:read

Query parameters

• orderingstring

  Which field to use when ordering the results.

• pageinteger

  A page number within the paginated result set.

Responses

200OKapplication/json

Response schema

object PaginatedDatalakeList

• 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 · Datalake

  • idintegerrequiredread-only
  • namestringrequired

    A human readable name.

    Max length 200

  • stackinteger
  • urlstringrequired

    The full URL for the storage engine.

    Max length 200

  • parametersany
  • backup_existingboolean

    Enable this option to create backups of existing files. Otherwise existing files will be silently overwritten.

  • authintegernullable

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/storage/' \
  --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,
      "url": "string",
      "parameters": null,
      "backup_existing": true,
      "auth": 1
    }
  ]
}

Create storage

POST/api/storage/

API keyNot supportedThis operation needs a signed-in Adverity user, so a Connect API key cannot call it. Use the Adverity app to do this.

Request bodyrequired

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

Body schema

object Datalake

• namestringrequired

  A human readable name.

  Max length 200

• stackinteger
• urlstringrequired

  The full URL for the storage engine.

  Max length 200

• parametersany
• backup_existingboolean

  Enable this option to create backups of existing files. Otherwise existing files will be silently overwritten.

• authintegernullable

Responses

201Createdapplication/json

Response schema

object Datalake

• idintegerrequiredread-only
• namestringrequired

  A human readable name.

  Max length 200

• stackinteger
• urlstringrequired

  The full URL for the storage engine.

  Max length 200

• parametersany
• backup_existingboolean

  Enable this option to create backups of existing files. Otherwise existing files will be silently overwritten.

• authintegernullable

RequestcURL

curl --request POST 'https://{{INSTANCE}}/api/storage/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string",
    "stack": 1,
    "url": "string",
    "parameters": null,
    "backup_existing": true,
    "auth": 1
  }'

Response201

{
  "id": 1,
  "name": "string",
  "stack": 1,
  "url": "string",
  "parameters": null,
  "backup_existing": true,
  "auth": 1
}

Get storage

GET/api/storage/{id}/

API key permissionWorkspace: Read-onlyworkspace:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Storage.

Responses

200OKapplication/json

Response schema

object Datalake

• idintegerrequiredread-only
• namestringrequired

  A human readable name.

  Max length 200

• stackinteger
• urlstringrequired

  The full URL for the storage engine.

  Max length 200

• parametersany
• backup_existingboolean

  Enable this option to create backups of existing files. Otherwise existing files will be silently overwritten.

• authintegernullable

RequestcURL

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

Response200

{
  "id": 1,
  "name": "string",
  "stack": 1,
  "url": "string",
  "parameters": null,
  "backup_existing": true,
  "auth": 1
}

Replace storage

PUT/api/storage/{id}/

API keyNot supportedThis operation needs a signed-in Adverity user, so a Connect API key cannot call it. Use the Adverity app to do this.

Path parameters

• idintegerrequired

  A unique integer value identifying this Storage.

Request bodyrequired

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

Body schema

object Datalake

• namestringrequired

  A human readable name.

  Max length 200

• stackinteger
• urlstringrequired

  The full URL for the storage engine.

  Max length 200

• parametersany
• backup_existingboolean

  Enable this option to create backups of existing files. Otherwise existing files will be silently overwritten.

• authintegernullable

Responses

200OKapplication/json

Response schema

object Datalake

• idintegerrequiredread-only
• namestringrequired

  A human readable name.

  Max length 200

• stackinteger
• urlstringrequired

  The full URL for the storage engine.

  Max length 200

• parametersany
• backup_existingboolean

  Enable this option to create backups of existing files. Otherwise existing files will be silently overwritten.

• authintegernullable

RequestcURL

curl --request PUT 'https://{{INSTANCE}}/api/storage/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string",
    "stack": 1,
    "url": "string",
    "parameters": null,
    "backup_existing": true,
    "auth": 1
  }'

Response200

{
  "id": 1,
  "name": "string",
  "stack": 1,
  "url": "string",
  "parameters": null,
  "backup_existing": true,
  "auth": 1
}

Update storage

PATCH/api/storage/{id}/

API keyNot supportedThis operation needs a signed-in Adverity user, so a Connect API key cannot call it. Use the Adverity app to do this.

Path parameters

• idintegerrequired

  A unique integer value identifying this Storage.

Request body

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

Body schema

object PatchedDatalake

• namestring

  A human readable name.

  Max length 200

• stackinteger
• urlstring

  The full URL for the storage engine.

  Max length 200

• parametersany
• backup_existingboolean

  Enable this option to create backups of existing files. Otherwise existing files will be silently overwritten.

• authintegernullable

Responses

200OKapplication/json

Response schema

object Datalake

• idintegerrequiredread-only
• namestringrequired

  A human readable name.

  Max length 200

• stackinteger
• urlstringrequired

  The full URL for the storage engine.

  Max length 200

• parametersany
• backup_existingboolean

  Enable this option to create backups of existing files. Otherwise existing files will be silently overwritten.

• authintegernullable

RequestcURL

curl --request PATCH 'https://{{INSTANCE}}/api/storage/{id}/' \
  --header 'Authorization: Bearer {{KEY}}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "string",
    "stack": 1,
    "url": "string",
    "parameters": null,
    "backup_existing": true,
    "auth": 1
  }'

Response200

{
  "id": 1,
  "name": "string",
  "stack": 1,
  "url": "string",
  "parameters": null,
  "backup_existing": true,
  "auth": 1
}

Delete storage

DELETE/api/storage/{id}/

API keyNot supportedThis operation needs a signed-in Adverity user, so a Connect API key cannot call it. Use the Adverity app to do this.

Path parameters

• idintegerrequired

  A unique integer value identifying this Storage.

Responses

204No response body

RequestcURL

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

Response204

No response body.

List value tables

GET/api/value-tables/

API key permissionWorkspace: Read-onlyworkspace: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.

• stackinteger

Responses

200OKapplication/json

Response schema

object PaginatedValueTableList

• 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 · ValueTable

  • idintegerrequiredread-only
  • stackinteger
  • namestringrequired

    A human readable name.

    Max length 100

  • entriesstringrequiredread-only

RequestcURL

curl --request GET 'https://{{INSTANCE}}/api/value-tables/' \
  --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,
      "stack": 1,
      "name": "string",
      "entries": "string"
    }
  ]
}

Create value tables

POST/api/value-tables/

API key permissionWorkspace: Writeworkspace:write

Request bodyrequired

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

Body schema

object ValueTable

• stackinteger
• namestringrequired

  A human readable name.

  Max length 100

Responses

201Createdapplication/json

Response schema

object ValueTable

• idintegerrequiredread-only
• stackinteger
• namestringrequired

  A human readable name.

  Max length 100

• entriesstringrequiredread-only

RequestcURL

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

Response201

{
  "id": 1,
  "stack": 1,
  "name": "string",
  "entries": "string"
}

Get value tables

GET/api/value-tables/{id}/

API key permissionWorkspace: Read-onlyworkspace:read

Path parameters

• idintegerrequired

  A unique integer value identifying this Value Table.

Responses

200OKapplication/json

Response schema

object ValueTable

• idintegerrequiredread-only
• stackinteger
• namestringrequired

  A human readable name.

  Max length 100

• entriesstringrequiredread-only

RequestcURL

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

Response200

{
  "id": 1,
  "stack": 1,
  "name": "string",
  "entries": "string"
}

Replace value tables

PUT/api/value-tables/{id}/

API key permissionWorkspace: Writeworkspace:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Value Table.

Request bodyrequired

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

Body schema

object ValueTable

• stackinteger
• namestringrequired

  A human readable name.

  Max length 100

Responses

200OKapplication/json

Response schema

object ValueTable

• idintegerrequiredread-only
• stackinteger
• namestringrequired

  A human readable name.

  Max length 100

• entriesstringrequiredread-only

RequestcURL

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

Response200

{
  "id": 1,
  "stack": 1,
  "name": "string",
  "entries": "string"
}

Update value tables

PATCH/api/value-tables/{id}/

API key permissionWorkspace: Writeworkspace:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Value Table.

Request body

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

Body schema

object PatchedValueTable

• stackinteger
• namestring

  A human readable name.

  Max length 100

Responses

200OKapplication/json

Response schema

object ValueTable

• idintegerrequiredread-only
• stackinteger
• namestringrequired

  A human readable name.

  Max length 100

• entriesstringrequiredread-only

RequestcURL

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

Response200

{
  "id": 1,
  "stack": 1,
  "name": "string",
  "entries": "string"
}

Delete value tables

DELETE/api/value-tables/{id}/

API key permissionWorkspace: Writeworkspace:write

Path parameters

• idintegerrequired

  A unique integer value identifying this Value Table.

Responses

204No response body

RequestcURL

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

Response204

No response body.

Was this page helpful? Yes No