Get All Object Data Records

Return a list of records of an object for the specified tenant.

Command

GET https://{server}/api/v1/{tenantId}/objectData/{objectDefnName}

Parameters

Name

Required

Data Type

Description

Parameter Type

tenantId

Yes

String

Unique identifier of the tenant.

Path

objectDefnName

Yes

String

Name of the object definition.

Query

filter

No

String

Spring Expression Language (EL) filter. Allows you to filter by a set of records (for example: name eq 'name'). For more details on using the filter query parameter, see Filtering Guidelines.

Query

offset

No

String

The number of items to skip before starting to collect the result set. Used with limit.

Query

limit

No

String

The maximum number of results to return. Used with offset. Together, they determine the start index and number of records to return. For example, to return records 5 through 15 that have been sorted by name, use the following:

objectDefnName?offset=5&limit=10&orderBy=name

Query

orderBy

No

String

Order by fields, sort order.

Query

select

No

String

Select the specific fields to be returned.

Query

count

No

String

The number of records to fetch from the database.

Query

groupBy

No

String

Categorization of results (group by a field).

Query

Responses

Status and Error Codes

See Common Status and Error Codes.

Successful Response Body

Field

Description

hostId

The identifier of the host instance that is returning the request.

status

The status of the request. Valid values:

  • SUCCESS - The operation was a success.

  • ERROR - A validation error occurred.

content

Returns an array of the records for the tenant. The structure is dependent on the master data definition.

messages

If the status is SUCCESS, this field is always blank. If the status is ERROR, a validation error occurred. For example, The URL includes an invalid master data definition name.

count

The number of records returned.

Examples

Sample API Call

 
GET http://company.com/api/v1/pX3459712f8/objectData/task
X-Application-Key: 30b5f27a684744116537882dda0e50efb8c5a6e26a7b7ad2f3fcb2c24436a840
Content-Type: application/json
Authorization: Bearer eyJhbGciOiJSUzI1NiIsImprdSI6Imh0dHB=

Successful Responses

Response Body Sample

 
{
    "hostId": "851df19545831252896a2c9c737e3fb9",
    "status": "SUCCESS",
    "content": [
        {
            "taskId": "z20061721072980179405741",
            "code": "TPS_001",
            "name": "Development"
        },
        {
            "taskId": "z20061721073559979477741",
            "code": "TPS_002",
            "name": "Testing"
        },
        {
            "taskId": "z20061721074437579546741",
            "code": "TPS_003",
            "name": "Deployment"
        },
        {
            "taskId": "z20061721074982779555741",
            "code": "TPS_004",
            "name": "Maintenance"
        }
    ],
    "messages": [],
    "count": 4
}

Error Responses

Response Body Error Sample - Object Definition Doesn't Exist on the Tenant

 
{
    "hostId": "f0481069a15e408ff4bbd948dec2d8ad",
    "status": "ERROR",
    "content": null,
    "messages": [
        {
            "type": "ERROR",
            "message": "Failed to Load Resource of Type ObjectDefn with Arguments [Task, pX596e728cc]",
            "code": "error.resourceNotFound",
            "arguments": {
                "type": "ObjectDefn",
                "arguments": "[Task, pX596e728cc]"
            },
            "key": "ObjectDefn"
        }
    ],
    "count": -1
}
Related Information