UpsertEntity

Create or update an entity. If the entity does not exist, it will be created, otherwise it will be updated. Entities are identified and deduplicated by their Identifier in a scope of a given customer workspace.

POST /api/entities/custom/v1

UpsertEntity

cURL

curl --request POST \
  --url https://developer.synq.io/api/entities/custom/v1 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": {
    "id": {
      "airflowDag": {
        "integrationId": "<string>",
        "dagId": "<string>"
      }
    },
    "name": "<string>",
    "workspace": "<string>",
    "typeId": 500,
    "entityType": "ENTITY_TYPE_UNSPECIFIED",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "synqPath": "<string>",
    "synqCatalogUrl": "<string>",
    "ids": [
      {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      }
    ],
    "synqPaths": [
      "<string>"
    ],
    "annotations": [
      {
        "name": "<string>",
        "values": [
          "<string>"
        ]
      }
    ]
  }
}
'

200

{}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

UpsertEntityRequest is the request message for the UpsertEntity method.

entity · Entity · object · required

The entity to create or update.

Show child attributes

Response

200 - application/json

Success

UpsertEntityResponse is the response message for the UpsertEntity method.