POST
/
synq.entities.entities.v1.EntitiesService
/
GetEntity
GetEntity
curl --request POST \
  --url https://developer.synq.io/synq.entities.entities.v1.EntitiesService/GetEntity \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '{
  "id": {
    "airflowDag": {
      "integrationId": "<string>",
      "dagId": "<string>"
    }
  }
}'
{
  "entity": {
    "workspace": "<string>",
    "id": {
      "airflowDag": {
        "integrationId": "<string>",
        "dagId": "<string>"
      }
    },
    "typeId": 123,
    "name": "<string>",
    "description": "<string>",
    "createdAt": "1s",
    "updatedAt": "1s",
    "deletedAt": "1s",
    "synqPath": "<string>",
    "synqCatalogUrl": "<string>",
    "ids": [
      {
        "airflowDag": {
          "integrationId": "<string>",
          "dagId": "<string>"
        }
      }
    ],
    "synqPaths": [
      "<string>"
    ],
    "annotations": [
      {
        "name": "<string>",
        "values": [
          "<string>"
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
​
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json

GetEntityRequest is the request message for the GetEntity method.

Response

200
application/json

Success

GetEntityResponse is the response message for the GetEntity method.