Get
/glrestapi/rest/v1/gldoccolumns
Query Standards
| Key | Recommended | Description |
|---|---|---|
| finder | Yes | Filters data based on attributes |
| limit | Yes | No. of items to return |
| offset | Yes | item index |
| totalResults | Yes | Returns total number of items |
| orderBy | Yes | Returns list of items order by given attribute |
Finder
Following row finders are available for data filtering and optimizing request performance.
- Select Doc Columns
- By UUID
Select Document Columns
This is the recommended finder for querying Document Columns by Document Code
| Parameter | Description | Sample |
|---|---|---|
| documentCode | Document Code | BALANCE |
By UUID
This is an optional finder for querying a specific Department by row ID.
| Parameter | Description | Sample |
|---|---|---|
| /VUUID | The VUuid attribute is the Unique row ID | /glrestapi/rest/v1/gldoccolumns/EA02BA00F5B18811E053B08610ACE770 |
Security
HTTP
Type basic
Basic authentication
Query parameters
finder
string
ExampleselectDocColumns;documentCode=BALANCE
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
Exampletrue
orderBy
string
ExampleDclTitle1:desc
Responses
200
OK
Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
example-0
Successful Response
{
"items": [
{
"DclBudgCode": null,
"DclBudgName": null,
"DclCol1Num": null,
"DclCol2Num": null,
"DclColCode": "Y1",
"DclColName": "YTD Balance",
"DclColNum": 1,
"DclColPer": null,
"DclColYr": null,
"DclCon2Code": "001",
"DclCon2Name": "Co Code 001",
"DclCon2OverrideCode": null,
"DclDocCode": "BALANCE",
"DclDocName": "Balance Sheet - Consolidated",
"DclFactor1": null,
"DclFactor2": null,
"DclIuCreateDate": "2021-09-28T20:42:07Z",
"DclIuCreateUser": "JONATHAN",
"DclIuUpdateDate": null,
"DclIuUpdateUser": null,
"DclPrintCode": "Y",
"DclTitle1": "Co 001",
"DclTitle2": "Current Year",
"DclTypeCode": null,
"DclSignOverrideFlag": null,
"DclScaleCode": "1",
"DclRevCode": "N",
"DclRatioCode": null,
"DclPscaleNum": 1,
"DclMaskName": "$999,999,999",
"DclMaskCode": "XD",
"DclFuncTypeName": "Yearly",
"DclFuncType": "Y",
"DclWidthNum": 12,
"DclVUuid": "EA02BA00F5B18811E053B08610ACE770",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoccolumns/EA02BA00F5B18811E053B08610ACE770",
"name": "gldoccolumns",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoccolumns/EA02BA00F5B18811E053B08610ACE770",
"name": "gldoccolumns",
"kind": "item"
}
]
},
{
"DclBudgCode": null,
"DclBudgName": null,
"DclCol1Num": null,
"DclCol2Num": null,
"DclColCode": "Y1",
"DclColName": "YTD Balance",
"DclColNum": 2,
"DclColPer": null,
"DclColYr": null,
"DclCon2Code": "002",
"DclCon2Name": "Co Code 002",
"DclCon2OverrideCode": null,
"DclDocCode": "BALANCE",
"DclDocName": "Balance Sheet - Consolidated",
"DclFactor1": null,
"DclFactor2": null,
"DclIuCreateDate": "2021-09-28T20:42:07Z",
"DclIuCreateUser": "JONATHAN",
"DclIuUpdateDate": null,
"DclIuUpdateUser": null,
"DclPrintCode": "Y",
"DclTitle1": "Co 002",
"DclTitle2": "Current Year",
"DclTypeCode": null,
"DclSignOverrideFlag": null,
"DclScaleCode": "1",
"DclRevCode": "N",
"DclRatioCode": null,
"DclPscaleNum": 1,
"DclMaskName": "$999,999,999",
"DclMaskCode": "XD",
"DclFuncTypeName": "Yearly",
"DclFuncType": "Y",
"DclWidthNum": 12,
"DclVUuid": "EA02BA00F5B28811E053B08610ACE770",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoccolumns/EA02BA00F5B28811E053B08610ACE770",
"name": "gldoccolumns",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoccolumns/EA02BA00F5B28811E053B08610ACE770",
"name": "gldoccolumns",
"kind": "item"
}
]
}
],
"totalResults": 4,
"count": 2,
"hasMore": true,
"limit": 2,
"offset": 0,
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoccolumns",
"name": "gldoccolumns",
"kind": "collection"
}
]
}example-1
Successful Response
{
"items": [
{
"DclBudgCode": null,
"DclBudgName": null,
"DclCol1Num": null,
"DclCol2Num": null,
"DclColCode": "Y1",
"DclColName": "YTD Balance",
"DclColNum": 1,
"DclColPer": null,
"DclColYr": null,
"DclCon2Code": "001",
"DclCon2Name": "Co Code 001",
"DclCon2OverrideCode": null,
"DclDocCode": "BALANCE",
"DclDocName": "Balance Sheet - Consolidated",
"DclFactor1": null,
"DclFactor2": null,
"DclIuCreateDate": "2021-09-28T20:42:07Z",
"DclIuCreateUser": "JONATHAN",
"DclIuUpdateDate": null,
"DclIuUpdateUser": null,
"DclPrintCode": "Y",
"DclTitle1": "Co 001",
"DclTitle2": "Current Year",
"DclTypeCode": null,
"DclSignOverrideFlag": null,
"DclScaleCode": "1",
"DclRevCode": "N",
"DclRatioCode": null,
"DclPscaleNum": 1,
"DclMaskName": "$999,999,999",
"DclMaskCode": "XD",
"DclFuncTypeName": "Yearly",
"DclFuncType": "Y",
"DclWidthNum": 12,
"DclVUuid": "EA02BA00F5B18811E053B08610ACE770",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoccolumns/EA02BA00F5B18811E053B08610ACE770",
"name": "gldoccolumns",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoccolumns/EA02BA00F5B18811E053B08610ACE770",
"name": "gldoccolumns",
"kind": "item"
}
]
},
{
"DclBudgCode": null,
"DclBudgName": null,
"DclCol1Num": null,
"DclCol2Num": null,
"DclColCode": "Y1",
"DclColName": "YTD Balance",
"DclColNum": 2,
"DclColPer": null,
"DclColYr": null,
"DclCon2Code": "002",
"DclCon2Name": "Co Code 002",
"DclCon2OverrideCode": null,
"DclDocCode": "BALANCE",
"DclDocName": "Balance Sheet - Consolidated",
"DclFactor1": null,
"DclFactor2": null,
"DclIuCreateDate": "2021-09-28T20:42:07Z",
"DclIuCreateUser": "JONATHAN",
"DclIuUpdateDate": null,
"DclIuUpdateUser": null,
"DclPrintCode": "Y",
"DclTitle1": "Co 002",
"DclTitle2": "Current Year",
"DclTypeCode": null,
"DclSignOverrideFlag": null,
"DclScaleCode": "1",
"DclRevCode": "N",
"DclRatioCode": null,
"DclPscaleNum": 1,
"DclMaskName": "$999,999,999",
"DclMaskCode": "XD",
"DclFuncTypeName": "Yearly",
"DclFuncType": "Y",
"DclWidthNum": 12,
"DclVUuid": "EA02BA00F5B28811E053B08610ACE770",
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoccolumns/EA02BA00F5B28811E053B08610ACE770",
"name": "gldoccolumns",
"kind": "item"
},
{
"rel": "canonical",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoccolumns/EA02BA00F5B28811E053B08610ACE770",
"name": "gldoccolumns",
"kind": "item"
}
]
}
],
"totalResults": 4,
"count": 2,
"hasMore": true,
"limit": 2,
"offset": 0,
"links": [
{
"rel": "self",
"href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldoccolumns",
"name": "gldoccolumns",
"kind": "collection"
}
]
}object