---
title: "Retrieve Documents by Object"
slug: "retrieve-documents-by-object"
updated: 2026-05-26T12:53:14Z
published: 2026-05-26T12:53:48Z
canonical: "developers.cmicglobal.com/retrieve-documents-by-object"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve Documents by Object

Get/sys-rest-api/rest/1/sysrelateddocquery

## Query Standards

### Finder

Following row finders are available for data filtering and optimizing request performance.

- Select by Object Key
- Select by Revision
- By UUID

#### Select by Object Key

This is the recommended finder for querying Documents by Object Keys. For the corresponding definitions of Object Keys for each object type. Please refer to the Object Key Table.

| Parameter | Description | Sample |
| --- | --- | --- |
| ObjectKey1 | Object Key 1 | 001 |
| ObjectKey2 | Object Key 2 | 14001 |
| ObjectKey3 | Object Key 3 | 0007 |
| ObjectKey4 | Object Key 4 | optional, do not include if n/a |

#### Select by Revision

This is the optional finder for querying Documents by Revision View ID. It is a unique identifier represents each revision of a document.

| Parameter | Description | Sample |
| --- | --- | --- |
| RevisionVuuid | Revision View ID | 9D08CBD16AAEE393E053788610ACDE84 |

#### By UUID

This is an optional finder for querying a specific Document by row ID.

| Parameter | Description | Sample |
| --- | --- | --- |
| /VUUID | The VUuid attribute is the Unique row ID | /sys-rest-api/rest/1/sysrelateddocquery/794614195F6787C4E053788610AC00F2 |

SecurityHTTPType basic

Basic authentication

Query parametersfinderstringExampleselectByObjectKey;ObjectType=PMRFI,ObjectKey1=001,ObjectKey2=14001,ObjectKey3=RFI-0149
limitintegerExample500
offsetintegerExample0
totalResultsbooleanExampletrue
orderBystringExampleSysrdAttName:desc

Responses200

OK

HeadersContent-TypestringExampleapplication/vnd.oracle.adf.resourcecollection+json
<select class='api-response-data' aria-label='Media type'><option value='72840f5f-e0cd-4ada-8935-b90b088aa08b'>application/json</option>
</select><select class='select-example' aria-label='Media type'><option value='8515667e-43cc-4cc4-810e-af5b6f9232f9'>example-0</option>
<option value='5cc2e24d-b3c0-4c96-878d-a6163609a91b'>example-1</option>
<option value='cafb0909-9e4e-42f3-b978-c18656116ed5'>example-2</option>
</select>example-0

Successful Response - FInder - selectByRevision

```json
{
  "items": [
    {
      "SysrdObjectType": "PMCMN",
      "SysrdObjectKey1": null,
      "SysrdObjectKey2": null,
      "SysrdObjectKey3": null,
      "SysrdObjectKey4": null,
      "SysrdPartnCode": "001",
      "SysrdPartnTypeCode": "C",
      "SysrdContactCode": "SC",
      "SysrdContactName": "Steve Cangiano",
      "SysrdDate": "2015-05-04T16:17:04Z",
      "SysrdStatus": "SUBMITTED",
      "SysrdDocTypeCode": "ATTACHMENT",
      "SysrdDocTypeName": "Attachment",
      "SysrdDocId": "00000001",
      "SysrdDocTitle": "15400-01 Spec Sheet",
      "SysrdDocStatusCode": null,
      "SysrdDocStatusClassCode": null,
      "SysrdStatusName": null,
      "SysrdRevNum": 0,
      "SysrdRevDate": "2015-05-04",
      "SysrdRevComment": "Original Version",
      "SysrdRevStatusCode": "OPEN",
      "SysrdRevStatusClassCode": "O",
      "SysrdAttRelNum": 0,
      "SysrdAttName": "00000001",
      "SysrdAttRelUser": "SC",
      "SysrdAttRelDate": "2015-05-04T16:17:04Z",
      "SysrdAttPath": "15400-01 Spec Sheet.pdf",
      "SysrdAttNote": null,
      "SysrdAttLockStatus": null,
      "SysrdAttLockUser": null,
      "SysrdAttLockDate": null,
      "SysrdCopiesNum": null,
      "SysrdVUuid": "7946140E81E387C4E053788610AC00F2",
      "SysrdRevisionVUuid": "9D08CBD16AAEE393E053788610ACDE84",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/7946140E81E387C4E053788610AC00F2",
          "name": "sysrelateddocquery",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/7946140E81E387C4E053788610AC00F2",
          "name": "sysrelateddocquery",
          "kind": "item"
        }
      ]
    },
    {
      "SysrdObjectType": "PMRFI",
      "SysrdObjectKey1": null,
      "SysrdObjectKey2": null,
      "SysrdObjectKey3": null,
      "SysrdObjectKey4": null,
      "SysrdPartnCode": "001",
      "SysrdPartnTypeCode": "C",
      "SysrdContactCode": "SC",
      "SysrdContactName": "Steve Cangiano",
      "SysrdDate": "2018-08-21T02:14:40Z",
      "SysrdStatus": "SUBMITTED",
      "SysrdDocTypeCode": "ATTACHMENT",
      "SysrdDocTypeName": "Attachment",
      "SysrdDocId": "00000001",
      "SysrdDocTitle": "15400-01 Spec Sheet",
      "SysrdDocStatusCode": null,
      "SysrdDocStatusClassCode": null,
      "SysrdStatusName": null,
      "SysrdRevNum": 0,
      "SysrdRevDate": "2015-05-04",
      "SysrdRevComment": "Original Version",
      "SysrdRevStatusCode": "OPEN",
      "SysrdRevStatusClassCode": "O",
      "SysrdAttRelNum": 0,
      "SysrdAttName": "00000001",
      "SysrdAttRelUser": "SC",
      "SysrdAttRelDate": "2015-05-04T16:17:04Z",
      "SysrdAttPath": "15400-01 Spec Sheet.pdf",
      "SysrdAttNote": null,
      "SysrdAttLockStatus": null,
      "SysrdAttLockUser": null,
      "SysrdAttLockDate": null,
      "SysrdCopiesNum": null,
      "SysrdVUuid": "794614195F6787C4E053788610AC00F2",
      "SysrdRevisionVUuid": "9D08CBD16AAEE393E053788610ACDE84",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/794614195F6787C4E053788610AC00F2",
          "name": "sysrelateddocquery",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/794614195F6787C4E053788610AC00F2",
          "name": "sysrelateddocquery",
          "kind": "item"
        }
      ]
    },
    {
      "SysrdObjectType": "PMRFI",
      "SysrdObjectKey1": null,
      "SysrdObjectKey2": null,
      "SysrdObjectKey3": null,
      "SysrdObjectKey4": null,
      "SysrdPartnCode": "001",
      "SysrdPartnTypeCode": "C",
      "SysrdContactCode": "SC",
      "SysrdContactName": "Steve Cangiano",
      "SysrdDate": "2018-08-07T12:59:56Z",
      "SysrdStatus": "SUBMITTED",
      "SysrdDocTypeCode": "ATTACHMENT",
      "SysrdDocTypeName": "Attachment",
      "SysrdDocId": "00000001",
      "SysrdDocTitle": "15400-01 Spec Sheet",
      "SysrdDocStatusCode": null,
      "SysrdDocStatusClassCode": null,
      "SysrdStatusName": null,
      "SysrdRevNum": 0,
      "SysrdRevDate": "2015-05-04",
      "SysrdRevComment": "Original Version",
      "SysrdRevStatusCode": "OPEN",
      "SysrdRevStatusClassCode": "O",
      "SysrdAttRelNum": 0,
      "SysrdAttName": "00000001",
      "SysrdAttRelUser": "SC",
      "SysrdAttRelDate": "2015-05-04T16:17:04Z",
      "SysrdAttPath": "15400-01 Spec Sheet.pdf",
      "SysrdAttNote": null,
      "SysrdAttLockStatus": null,
      "SysrdAttLockUser": null,
      "SysrdAttLockDate": null,
      "SysrdCopiesNum": null,
      "SysrdVUuid": "79461419A42687C4E053788610AC00F2",
      "SysrdRevisionVUuid": "9D08CBD16AAEE393E053788610ACDE84",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/79461419A42687C4E053788610AC00F2",
          "name": "sysrelateddocquery",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/79461419A42687C4E053788610AC00F2",
          "name": "sysrelateddocquery",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 3,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery",
      "name": "sysrelateddocquery",
      "kind": "collection"
    }
  ]
}
```

example-1

Successful Response - FInder - selectByObjectKey

```json
{
  "items": [
    {
      "SysrdObjectType": "PMRFI",
      "SysrdObjectKey1": null,
      "SysrdObjectKey2": null,
      "SysrdObjectKey3": null,
      "SysrdObjectKey4": null,
      "SysrdPartnCode": "001",
      "SysrdPartnTypeCode": "C",
      "SysrdContactCode": "SS",
      "SysrdContactName": "Melissa Afkari",
      "SysrdDate": "2022-06-15T14:55:00Z",
      "SysrdStatus": "SUBMITTED",
      "SysrdDocTypeCode": "ATTACHMENT",
      "SysrdDocTypeName": "Attachment",
      "SysrdDocId": "87008009",
      "SysrdDocTitle": "RFI-0149-RFI-Navis test [824753629]",
      "SysrdDocStatusCode": null,
      "SysrdDocStatusClassCode": null,
      "SysrdStatusName": null,
      "SysrdRevNum": 0,
      "SysrdRevDate": "2022-06-15T14:55:00Z",
      "SysrdRevComment": "(No Description)",
      "SysrdRevStatusCode": null,
      "SysrdRevStatusClassCode": null,
      "SysrdAttRelNum": 0,
      "SysrdAttName": "87008009",
      "SysrdAttRelUser": "CMICUSER",
      "SysrdAttRelDate": "2022-06-15T14:55:01Z",
      "SysrdAttPath": "RFI-0149-RFI-Navis test [824753629].pdf",
      "SysrdAttNote": null,
      "SysrdAttLockStatus": null,
      "SysrdAttLockUser": null,
      "SysrdAttLockDate": null,
      "SysrdCopiesNum": null,
      "SysrdVUuid": "E17EB48A26061106E05316821FACB822",
      "SysrdRevisionVUuid": "E17EB48A26041106E05316821FACB822",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/E17EB48A26061106E05316821FACB822",
          "name": "sysrelateddocquery",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/E17EB48A26061106E05316821FACB822",
          "name": "sysrelateddocquery",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery",
      "name": "sysrelateddocquery",
      "kind": "collection"
    }
  ]
}
```

example-2

Successful Response - FInder - selectByObjectKey

```json
{
  "items": [
    {
      "SysrdObjectType": "PMPL",
      "SysrdObjectKey1": null,
      "SysrdObjectKey2": null,
      "SysrdObjectKey3": null,
      "SysrdObjectKey4": null,
      "SysrdPartnCode": "001",
      "SysrdPartnTypeCode": "C",
      "SysrdContactCode": "SS",
      "SysrdContactName": "Melissa Afkari",
      "SysrdDate": "2023-06-27T20:04:14Z",
      "SysrdStatus": "SUBMITTED",
      "SysrdDocTypeCode": "ATTACHMENT",
      "SysrdDocTypeName": "Attachment",
      "SysrdDocId": "87008101",
      "SysrdDocTitle": "afterfix1",
      "SysrdDocStatusCode": null,
      "SysrdDocStatusClassCode": null,
      "SysrdStatusName": null,
      "SysrdRevNum": 0,
      "SysrdRevDate": "2023-06-27T20:04:14Z",
      "SysrdRevComment": "Original Version",
      "SysrdRevStatusCode": null,
      "SysrdRevStatusClassCode": null,
      "SysrdAttRelNum": 0,
      "SysrdAttName": "87008101",
      "SysrdAttRelUser": "CMICUSER",
      "SysrdAttRelDate": "2023-06-27T20:04:14Z",
      "SysrdAttPath": "afterfix1.png",
      "SysrdAttNote": "Original Version",
      "SysrdAttLockStatus": null,
      "SysrdAttLockUser": null,
      "SysrdAttLockDate": null,
      "SysrdCopiesNum": null,
      "SysrdVUuid": "FF22F8A6203F2642E05316821FACFD4E",
      "SysrdRevisionVUuid": "FF22F8A6203D2642E05316821FACFD4E",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/FF22F8A6203F2642E05316821FACFD4E",
          "name": "sysrelateddocquery",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/FF22F8A6203F2642E05316821FACFD4E",
          "name": "sysrelateddocquery",
          "kind": "item"
        }
      ]
    },
    {
      "SysrdObjectType": "PMPL",
      "SysrdObjectKey1": null,
      "SysrdObjectKey2": null,
      "SysrdObjectKey3": null,
      "SysrdObjectKey4": null,
      "SysrdPartnCode": "001",
      "SysrdPartnTypeCode": "C",
      "SysrdContactCode": "SS",
      "SysrdContactName": "Melissa Afkari",
      "SysrdDate": "2023-06-27T20:04:15Z",
      "SysrdStatus": "SUBMITTED",
      "SysrdDocTypeCode": "ATTACHMENT",
      "SysrdDocTypeName": "Attachment",
      "SysrdDocId": "87008102",
      "SysrdDocTitle": "afterfix2",
      "SysrdDocStatusCode": null,
      "SysrdDocStatusClassCode": null,
      "SysrdStatusName": null,
      "SysrdRevNum": 0,
      "SysrdRevDate": "2023-06-27T20:04:15Z",
      "SysrdRevComment": "Original Version",
      "SysrdRevStatusCode": null,
      "SysrdRevStatusClassCode": null,
      "SysrdAttRelNum": 0,
      "SysrdAttName": "87008102",
      "SysrdAttRelUser": "CMICUSER",
      "SysrdAttRelDate": "2023-06-27T20:04:15Z",
      "SysrdAttPath": "afterfix2.png",
      "SysrdAttNote": "Original Version",
      "SysrdAttLockStatus": null,
      "SysrdAttLockUser": null,
      "SysrdAttLockDate": null,
      "SysrdCopiesNum": null,
      "SysrdVUuid": "FF22F8A620462642E05316821FACFD4E",
      "SysrdRevisionVUuid": "FF22F8A620442642E05316821FACFD4E",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/FF22F8A620462642E05316821FACFD4E",
          "name": "sysrelateddocquery",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/FF22F8A620462642E05316821FACFD4E",
          "name": "sysrelateddocquery",
          "kind": "item"
        }
      ]
    },
    {
      "SysrdObjectType": "PMPL",
      "SysrdObjectKey1": null,
      "SysrdObjectKey2": null,
      "SysrdObjectKey3": null,
      "SysrdObjectKey4": null,
      "SysrdPartnCode": "001",
      "SysrdPartnTypeCode": "C",
      "SysrdContactCode": "SS",
      "SysrdContactName": "Melissa Afkari",
      "SysrdDate": "2023-06-27T20:04:15Z",
      "SysrdStatus": "SUBMITTED",
      "SysrdDocTypeCode": "ATTACHMENT",
      "SysrdDocTypeName": "Attachment",
      "SysrdDocId": "87008103",
      "SysrdDocTitle": "afterfix3",
      "SysrdDocStatusCode": null,
      "SysrdDocStatusClassCode": null,
      "SysrdStatusName": null,
      "SysrdRevNum": 0,
      "SysrdRevDate": "2023-06-27T20:04:15Z",
      "SysrdRevComment": "Original Version",
      "SysrdRevStatusCode": null,
      "SysrdRevStatusClassCode": null,
      "SysrdAttRelNum": 0,
      "SysrdAttName": "87008103",
      "SysrdAttRelUser": "CMICUSER",
      "SysrdAttRelDate": "2023-06-27T20:04:15Z",
      "SysrdAttPath": "afterfix3.png",
      "SysrdAttNote": "Original Version",
      "SysrdAttLockStatus": null,
      "SysrdAttLockUser": null,
      "SysrdAttLockDate": null,
      "SysrdCopiesNum": null,
      "SysrdVUuid": "FF22F8A6204D2642E05316821FACFD4E",
      "SysrdRevisionVUuid": "FF22F8A6204B2642E05316821FACFD4E",
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/FF22F8A6204D2642E05316821FACFD4E",
          "name": "sysrelateddocquery",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery/FF22F8A6204D2642E05316821FACFD4E",
          "name": "sysrelateddocquery",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 3,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sysrelateddocquery",
      "name": "sysrelateddocquery",
      "kind": "collection"
    }
  ]
}
```

object
