GenericObjects REST API

Generic Objects REST API documentation and interactive testing.

For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/genericobjects/contract

---

Create a Generic Object

post

Authorizations

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

X-ObjectsGrid-RestApiVersionstringoptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringoptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

idstringoptional

objectIDstringoptional

objectTypestringrequired

namespacestringoptional

intAttributesobject[]optional

floatAttributesobject[]optional

stringAttributesobject[]optional

booleanAttributesobject[]optional

dateAttributesobject[]optional

objectAttributesobject[]optional

referenceAttributesobject[]optional

tagsobject[]optional

metaobjectoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

post

cURLJavaScriptPythonHTTP

curl -L \
  --request POST \
  --url 'https://apis.objectsgrid.com/genericobjects' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "objectID": "text",
    "objectType": "text",
    "namespace": "text",
    "intAttributes": [
      {
        "name": "text",
        "val": 1
      }
    ],
    "floatAttributes": [
      {
        "name": "text",
        "val": 1
      }
    ],
    "stringAttributes": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "booleanAttributes": [
      {
        "name": "text",
        "val": true
      }
    ],
    "dateAttributes": [
      {
        "name": "text",
        "val": "2025-04-11T02:46:24.985Z"
      }
    ],
    "objectAttributes": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "referenceAttributes": [
      {
        "objectType": "text",
        "objectID": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2025-04-11T02:46:24.985Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-04-11T02:46:24.985Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }'

201

400

401

409

427

500

201

{
  "id": "text",
  "objectID": "text",
  "objectType": "text",
  "namespace": "text",
  "intAttributes": [
    {
      "name": "text",
      "val": 1
    }
  ],
  "floatAttributes": [
    {
      "name": "text",
      "val": 1
    }
  ],
  "stringAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "booleanAttributes": [
    {
      "name": "text",
      "val": true
    }
  ],
  "dateAttributes": [
    {
      "name": "text",
      "val": "2025-04-11T02:46:24.985Z"
    }
  ],
  "objectAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "referenceAttributes": [
    {
      "objectType": "text",
      "objectID": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T02:46:24.985Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T02:46:24.985Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully created the service account

List Generic Objects

get

This operation supports Elastic Search Query DSL query format

Authorizations

Query parameters

querystringoptional

Elastic Search Query DSL for querying Generic Objects. Examples:

• '{ "query": { "match": {"deleted": false} } }' for all objects that have not been deleted
• '{ "query": { "match_all": {} } }' for all objects including the deleted objects

Example: '{ "query": { "match": {"deleted": false} } }

fromintegeroptional

Defines the starting record number for retrieval.

sizeintegeroptional

Defines the number of records to retrieve.

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

X-ObjectsGrid-RestApiVersionstringoptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringoptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses

application/json

application/json

application/json

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://apis.objectsgrid.com/genericobjects' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU'

200

400

401

427

500

200

[
  {
    "id": "text",
    "objectID": "text",
    "objectType": "text",
    "namespace": "text",
    "intAttributes": [
      {
        "name": "text",
        "val": 1
      }
    ],
    "floatAttributes": [
      {
        "name": "text",
        "val": 1
      }
    ],
    "stringAttributes": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "booleanAttributes": [
      {
        "name": "text",
        "val": true
      }
    ],
    "dateAttributes": [
      {
        "name": "text",
        "val": "2025-04-11T02:46:24.985Z"
      }
    ],
    "objectAttributes": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "referenceAttributes": [
      {
        "objectType": "text",
        "objectID": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2025-04-11T02:46:24.985Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-04-11T02:46:24.985Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }
]

Successfully listed the generic objects

Retrieve a Generic Object

get

Authorizations

Path parameters

idstringrequired

ID of the service account to retrieve

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

X-ObjectsGrid-RestApiVersionstringoptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringoptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

get

cURLJavaScriptPythonHTTP

curl -L \
  --url 'https://apis.objectsgrid.com/genericobjects/{id}' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU'

200

400

401

404

427

500

200

{
  "id": "text",
  "objectID": "text",
  "objectType": "text",
  "namespace": "text",
  "intAttributes": [
    {
      "name": "text",
      "val": 1
    }
  ],
  "floatAttributes": [
    {
      "name": "text",
      "val": 1
    }
  ],
  "stringAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "booleanAttributes": [
    {
      "name": "text",
      "val": true
    }
  ],
  "dateAttributes": [
    {
      "name": "text",
      "val": "2025-04-11T02:46:24.985Z"
    }
  ],
  "objectAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "referenceAttributes": [
    {
      "objectType": "text",
      "objectID": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T02:46:24.985Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T02:46:24.985Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully retrieved the generic object

Update a Generic Object

put

Authorizations

Path parameters

idstringrequired

ID of the generic object to update

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

X-ObjectsGrid-RestApiVersionstringoptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringoptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

idstringoptional

objectIDstringoptional

objectTypestringrequired

namespacestringoptional

intAttributesobject[]optional

floatAttributesobject[]optional

stringAttributesobject[]optional

booleanAttributesobject[]optional

dateAttributesobject[]optional

objectAttributesobject[]optional

referenceAttributesobject[]optional

tagsobject[]optional

metaobjectoptional

Responses

application/json

application/json

application/json

application/json

application/json

application/json

put

cURLJavaScriptPythonHTTP

curl -L \
  --request PUT \
  --url 'https://apis.objectsgrid.com/genericobjects/{id}' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": "text",
    "objectID": "text",
    "objectType": "text",
    "namespace": "text",
    "intAttributes": [
      {
        "name": "text",
        "val": 1
      }
    ],
    "floatAttributes": [
      {
        "name": "text",
        "val": 1
      }
    ],
    "stringAttributes": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "booleanAttributes": [
      {
        "name": "text",
        "val": true
      }
    ],
    "dateAttributes": [
      {
        "name": "text",
        "val": "2025-04-11T02:46:24.985Z"
      }
    ],
    "objectAttributes": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "referenceAttributes": [
      {
        "objectType": "text",
        "objectID": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2025-04-11T02:46:24.985Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-04-11T02:46:24.985Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }'

200

400

401

404

427

500

200

{
  "id": "text",
  "objectID": "text",
  "objectType": "text",
  "namespace": "text",
  "intAttributes": [
    {
      "name": "text",
      "val": 1
    }
  ],
  "floatAttributes": [
    {
      "name": "text",
      "val": 1
    }
  ],
  "stringAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "booleanAttributes": [
    {
      "name": "text",
      "val": true
    }
  ],
  "dateAttributes": [
    {
      "name": "text",
      "val": "2025-04-11T02:46:24.985Z"
    }
  ],
  "objectAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "referenceAttributes": [
    {
      "objectType": "text",
      "objectID": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-04-11T02:46:24.985Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-04-11T02:46:24.985Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

Successfully updated the Generic Object

Delete a Generic Object

delete

Deletes the Generic Object

Authorizations

Path parameters

idstringrequired

ID of the Generic Object to delete

Header parameters

X-ObjectsGrid-AccessPointstring · enumrequired

EU or US depending on where your Organization Account is located

Available options:

X-ObjectsGrid-RestApiVersionstringoptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringoptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses

application/json

application/json

application/json

application/json

application/json

delete

cURLJavaScriptPythonHTTP

curl -L \
  --request DELETE \
  --url 'https://apis.objectsgrid.com/genericobjects/{id}' \
  --header 'Authorization: Bearer Bearer JWT' \
  --header 'X-ObjectsGrid-AccessPoint: EU'

200

400

401

404

427

500

200

No Content

Successfully deleted the Generic Object