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

Possible values:

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

Responses

201

Successfully created the service account

application/json

400

Bad request

application/json

401

Unauthorized

application/json

409

Conflict, the service account already exists

application/json

427

Too Many Requests - rate limited

application/json

500

Internal Server Error

application/json

post

HTTPcURLJavaScriptPython

POST /genericobjects HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 698

{
  "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-05-28T20:34:07.626Z"
    }
  ],
  "objectAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "referenceAttributes": [
    {
      "objectType": "text",
      "objectID": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T20:34:07.626Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T20:34:07.626Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

{
  "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-05-28T20:34:07.626Z"
    }
  ],
  "objectAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "referenceAttributes": [
    {
      "objectType": "text",
      "objectID": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T20:34:07.626Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T20:34:07.626Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

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

Possible values:

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

200

Successfully listed the generic objects

application/json

400

Bad request

application/json

401

Unauthorized

application/json

427

Too Many Requests - rate limited

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /genericobjects HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

[
  {
    "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-05-28T20:34:07.626Z"
      }
    ],
    "objectAttributes": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "referenceAttributes": [
      {
        "objectType": "text",
        "objectID": "text"
      }
    ],
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2025-05-28T20:34:07.626Z",
      "createdBy": "text",
      "lastUpdatedAt": "2025-05-28T20:34:07.626Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }
]

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

Possible values:

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

200

Successfully retrieved the generic object

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

427

Too Many Requests

application/json

500

Internal server error

application/json

get

HTTPcURLJavaScriptPython

GET /genericobjects/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

{
  "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-05-28T20:34:07.626Z"
    }
  ],
  "objectAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "referenceAttributes": [
    {
      "objectType": "text",
      "objectID": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T20:34:07.626Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T20:34:07.626Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

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

Possible values:

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

Responses

200

Successfully updated the Generic Object

application/json

400

Bad request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

427

Too Many Requests

application/json

500

Internal server error

application/json

put

HTTPcURLJavaScriptPython

PUT /genericobjects/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 698

{
  "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-05-28T20:34:07.626Z"
    }
  ],
  "objectAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "referenceAttributes": [
    {
      "objectType": "text",
      "objectID": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T20:34:07.626Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T20:34:07.626Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

{
  "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-05-28T20:34:07.626Z"
    }
  ],
  "objectAttributes": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "referenceAttributes": [
    {
      "objectType": "text",
      "objectID": "text"
    }
  ],
  "tags": [
    {
      "name": "text",
      "val": "text"
    }
  ],
  "meta": {
    "objectVersion": 1,
    "objectType": "text",
    "namespace": "text",
    "createdAt": "2025-05-28T20:34:07.626Z",
    "createdBy": "text",
    "lastUpdatedAt": "2025-05-28T20:34:07.626Z",
    "lastUpdatedBy": "text",
    "lastUpdateCorrelationID": "text"
  }
}

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

Possible values:

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

200

Successfully deleted the Generic Object

400

Bad request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

427

Too Many Requests

application/json

500

Internal server error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /genericobjects/{id} HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer Bearer JWT
X-ObjectsGrid-AccessPoint: EU
Accept: */*

No content