🚧

Authentication

All BigPanda APIs require Bearer Token Authorization in the call headers.

This API uses the Org Token type of Authorization token.

Sample Calls

curl --request PATCH \
     --url https://api.bigpanda.io/resources/v1.0/enrichments/8ded2313-0ebd-42e5-a36c-120420674863/map \
     --header 'Authorization: Bearer <ORG TOKEN>' \
     --header 'Content-Type: application/json; charset=utf8' \
     --data '[
           {
               "op": "create",
               "value": {
                   "application": "accounts",
                   "owner": "Merle Kayden",
                   "Runbook URL": "https://acme-wiki.com/accts+runbook"
               }
           },
           {
               "op": "upsert",
               "value": {
                   "application": "payroll",
                   "owner": "Jackie Celeste",
                   "Runbook URL": "https://acme-wiki.com/payroll+app+SOP"
               }
           },
           {
               "op": "delete",
               "value": {
                   "application": "sales"
               }
           }
    ]'

curl --request PATCH \
     --url https://eu-api.bigpanda.io/resources/v1.0/enrichments/8ded2313-0ebd-42e5-a36c-120420674863/map \
     --header 'Authorization: Bearer <ORG TOKEN>' \
     --header 'Content-Type: application/json; charset=utf8' \
     --data '[
           {
               "op": "create",
               "value": {
                   "application": "accounts",
                   "owner": "Merle Kayden",
                   "Runbook URL": "https://acme-wiki.com/accts+runbook"
               }
           },
           {
               "op": "upsert",
               "value": {
                   "application": "payroll",
                   "owner": "Jackie Celeste",
                   "Runbook URL": "https://acme-wiki.com/payroll+app+SOP"
               }
           },
           {
               "op": "delete",
               "value": {
                   "application": "sales"
               }
           }
    ]'

Usage

Use this action to update specific rows in an existing mapping enrichment table. To completely replace the existing table, see Create Mapping Enrichment Table. For each row, send the operation to perform and the values required to perform the operation. You can send up to 100 operations per request. The API supports these operations:

• create—adds a new row in the table. Requires values for every column in the row. If the row already exists, this operation will fail.
• update—updates an existing row in the table. Requires values for every column in the row.
• delete—removes an existing row from the table. Requires values for the query fields only. If the row does not exist, this operation will succeed but the version count will not be incremented.
• upsert—adds a new row, if the row doesn't exist, or updates the row, if it already exists. Requires values for every column in the row.

Because it is a potentially long-running action, the table update is performed asynchronously. Therefore, the immediate response indicates only whether the request was properly formatted and, if it was, provides a URL for checking the status of the upload. The entire table update must complete successfully for the changes to take effect; the API does not support partial success.

A typical asynchronous upload negotiation consists of these steps:

1. Send the update request.
   A Job object is created and a URL for checking the status is returned.
2. Use the URL to periodically check the job status until it is set to done or failed.
3. If the job was not successful, you can retry the request.
   If necessary, debug any connectivity issues or data formatting issues that may have contributed to the failed upload. For example, ensure the CSV file follows the enrichment schema definition.