Skip to main content
POST
/
core.v1.InventoryService
/
GetInventoryObject
cURL
curl -X POST "https://api.joinformal.com/core.v1.InventoryService/GetInventoryObject" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "example": "value"
  }'
{
  "object": {
    "column": {
      "id": "<string>",
      "resourceId": "<string>",
      "name": "<string>",
      "path": "<string>",
      "dataLabel": "<string>",
      "dataLabelV2": "<string>",
      "dataType": "<string>",
      "dataTypeOid": 123,
      "dataLabelLockedForSidecar": true,
      "tags": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "resourceName": "<string>",
      "markedForDeletionAt": "2023-11-07T05:31:56Z"
    },
    "datastore": {
      "id": "<string>",
      "name": "<string>",
      "technology": "<string>",
      "dbs": [
        {
          "id": "<string>",
          "resourceId": "<string>",
          "name": "<string>",
          "path": "<string>",
          "schemas": [
            {
              "id": "<string>",
              "resourceId": "<string>",
              "name": "<string>",
              "path": "<string>",
              "tables": [
                {
                  "id": "<string>",
                  "resourceId": "<string>",
                  "name": "<string>",
                  "path": "<string>",
                  "columns": [
                    {
                      "id": "<string>",
                      "resourceId": "<string>",
                      "name": "<string>",
                      "path": "<string>",
                      "dataLabel": "<string>",
                      "dataLabelV2": "<string>",
                      "dataType": "<string>",
                      "dataTypeOid": 123,
                      "dataLabelLockedForSidecar": true,
                      "tags": [
                        "<string>"
                      ],
                      "createdAt": "2023-11-07T05:31:56Z",
                      "updatedAt": "2023-11-07T05:31:56Z",
                      "resourceName": "<string>",
                      "markedForDeletionAt": "2023-11-07T05:31:56Z"
                    }
                  ],
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z",
                  "resourceName": "<string>",
                  "markedForDeletionAt": "2023-11-07T05:31:56Z"
                }
              ],
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "resourceName": "<string>",
              "markedForDeletionAt": "2023-11-07T05:31:56Z"
            }
          ],
          "tables": [
            {
              "id": "<string>",
              "resourceId": "<string>",
              "name": "<string>",
              "path": "<string>",
              "columns": [
                {
                  "id": "<string>",
                  "resourceId": "<string>",
                  "name": "<string>",
                  "path": "<string>",
                  "dataLabel": "<string>",
                  "dataLabelV2": "<string>",
                  "dataType": "<string>",
                  "dataTypeOid": 123,
                  "dataLabelLockedForSidecar": true,
                  "tags": [
                    "<string>"
                  ],
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z",
                  "resourceName": "<string>",
                  "markedForDeletionAt": "2023-11-07T05:31:56Z"
                }
              ],
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "resourceName": "<string>",
              "markedForDeletionAt": "2023-11-07T05:31:56Z"
            }
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "resourceName": "<string>",
          "markedForDeletionAt": "2023-11-07T05:31:56Z"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "db": {
      "id": "<string>",
      "resourceId": "<string>",
      "name": "<string>",
      "path": "<string>",
      "schemas": [
        {
          "id": "<string>",
          "resourceId": "<string>",
          "name": "<string>",
          "path": "<string>",
          "tables": [
            {
              "id": "<string>",
              "resourceId": "<string>",
              "name": "<string>",
              "path": "<string>",
              "columns": [
                {
                  "id": "<string>",
                  "resourceId": "<string>",
                  "name": "<string>",
                  "path": "<string>",
                  "dataLabel": "<string>",
                  "dataLabelV2": "<string>",
                  "dataType": "<string>",
                  "dataTypeOid": 123,
                  "dataLabelLockedForSidecar": true,
                  "tags": [
                    "<string>"
                  ],
                  "createdAt": "2023-11-07T05:31:56Z",
                  "updatedAt": "2023-11-07T05:31:56Z",
                  "resourceName": "<string>",
                  "markedForDeletionAt": "2023-11-07T05:31:56Z"
                }
              ],
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "resourceName": "<string>",
              "markedForDeletionAt": "2023-11-07T05:31:56Z"
            }
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "resourceName": "<string>",
          "markedForDeletionAt": "2023-11-07T05:31:56Z"
        }
      ],
      "tables": [
        {
          "id": "<string>",
          "resourceId": "<string>",
          "name": "<string>",
          "path": "<string>",
          "columns": [
            {
              "id": "<string>",
              "resourceId": "<string>",
              "name": "<string>",
              "path": "<string>",
              "dataLabel": "<string>",
              "dataLabelV2": "<string>",
              "dataType": "<string>",
              "dataTypeOid": 123,
              "dataLabelLockedForSidecar": true,
              "tags": [
                "<string>"
              ],
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "resourceName": "<string>",
              "markedForDeletionAt": "2023-11-07T05:31:56Z"
            }
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "resourceName": "<string>",
          "markedForDeletionAt": "2023-11-07T05:31:56Z"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "resourceName": "<string>",
      "markedForDeletionAt": "2023-11-07T05:31:56Z"
    },
    "schema": {
      "id": "<string>",
      "resourceId": "<string>",
      "name": "<string>",
      "path": "<string>",
      "tables": [
        {
          "id": "<string>",
          "resourceId": "<string>",
          "name": "<string>",
          "path": "<string>",
          "columns": [
            {
              "id": "<string>",
              "resourceId": "<string>",
              "name": "<string>",
              "path": "<string>",
              "dataLabel": "<string>",
              "dataLabelV2": "<string>",
              "dataType": "<string>",
              "dataTypeOid": 123,
              "dataLabelLockedForSidecar": true,
              "tags": [
                "<string>"
              ],
              "createdAt": "2023-11-07T05:31:56Z",
              "updatedAt": "2023-11-07T05:31:56Z",
              "resourceName": "<string>",
              "markedForDeletionAt": "2023-11-07T05:31:56Z"
            }
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "resourceName": "<string>",
          "markedForDeletionAt": "2023-11-07T05:31:56Z"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "resourceName": "<string>",
      "markedForDeletionAt": "2023-11-07T05:31:56Z"
    },
    "subColumn": {
      "id": "<string>",
      "resourceId": "<string>",
      "name": "<string>",
      "path": "<string>",
      "dataLabel": "<string>",
      "dataLabelV2": "<string>",
      "dataType": "<string>",
      "dataTypeOid": 123,
      "dataLabelLockedForSidecar": true,
      "tags": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "resourceName": "<string>",
      "markedForDeletionAt": "2023-11-07T05:31:56Z"
    },
    "table": {
      "id": "<string>",
      "resourceId": "<string>",
      "name": "<string>",
      "path": "<string>",
      "columns": [
        {
          "id": "<string>",
          "resourceId": "<string>",
          "name": "<string>",
          "path": "<string>",
          "dataLabel": "<string>",
          "dataLabelV2": "<string>",
          "dataType": "<string>",
          "dataTypeOid": 123,
          "dataLabelLockedForSidecar": true,
          "tags": [
            "<string>"
          ],
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "resourceName": "<string>",
          "markedForDeletionAt": "2023-11-07T05:31:56Z"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "resourceName": "<string>",
      "markedForDeletionAt": "2023-11-07T05:31:56Z"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.formal.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-KEY
string
header
required

API key authentication. Get your API key from the Formal console.

Body

application/json
​
id
string
Minimum string length: 1

Response

Success

​
object
object · object

Exactly one of these fields is required: column or datastore or db or schema or sub_column or table.