curl -X POST "https://api.joinformal.com/core.v1.InventoryService/ListInventoryObjects" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"example": "value"
}'{
"inventory": [
{
"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"
}
}
],
"listMetadata": {
"after": "<string>",
"before": "<string>",
"count": 123,
"nextCursor": "<string>"
}
}curl -X POST "https://api.joinformal.com/core.v1.InventoryService/ListInventoryObjects" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"example": "value"
}'{
"inventory": [
{
"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"
}
}
],
"listMetadata": {
"after": "<string>",
"before": "<string>",
"count": 123,
"nextCursor": "<string>"
}
}API key authentication. Get your API key from the Formal console.
Was this page helpful?
Suggestions