Retrieve GL Document rows By Code
    • 25 Sep 2024
    • 1 Minute to read
    • Dark
      Light

    Retrieve GL Document rows By Code

    • Dark
      Light

    Article summary

    Get
    /glrestapi/rest/v1/gldocrows

    Query Standards

    KeyRecommendedDescription
    finderYesFilters data based on attributes
    limitYesNo. of items to return
    offsetYesitem index
    totalResultsYesReturns total number of items
    orderByYesReturns list of items order by given attribute

    Finder

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

    • Select Doc Row
    • By UUID

    Select Document Row

    This is the recommended finder for querying Document Rows by Document Code

    ParameterDescriptionSample
    documentCodeDocument CodeBALANCE

    By UUID

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

    ParameterDescriptionSample
    /VUUIDThe VUuid attribute is the Unique row ID/glrestapi/rest/v1/gldocrows/EA02BA00F5B18811E053B08610ACE770
    Security
    HTTP
    Type basic

    Basic authentication

    Query parameters
    finder
    string
    ExampleselectDocRows;documentCode=BALANCE
    limit
    integer
    Example500
    offset
    integer
    Example0
    totalResults
    boolean
    Exampletrue
    orderBy
    string
    ExampleDapSeqNum:desc
    Responses
    200

    OK

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourcecollection+json
    {
      "items": [
        {
          "DapSeqNum": 100,
          "DapLineName": "Range",
          "DapLineCode": "R",
          "DapPrintCode": "Y",
          "DapRevCode": "N",
          "DapStoreCode": null,
          "DapTotal1Code": null,
          "DapTotal2Code": null,
          "DapTotalNum": null,
          "DapStartAccCode": null,
          "DapStartAccSeq": null,
          "DapEndAccCode": null,
          "DapEndAccSeq": null,
          "DapDocName": "Balance Sheet - Consolidated",
          "DapDocCode": "BALANCE",
          "DapDesc": "ASSETS",
          "DapCon2Code": null,
          "DapCon2Name": null,
          "DapVUuid": "EA02BA020ADA8811E053B08610ACE770",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldocrows/EA02BA020ADA8811E053B08610ACE770",
              "name": "gldocrows",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldocrows/EA02BA020ADA8811E053B08610ACE770",
              "name": "gldocrows",
              "kind": "item"
            }
          ]
        },
        {
          "DapSeqNum": 920,
          "DapLineName": "Range",
          "DapLineCode": "R",
          "DapPrintCode": "Y",
          "DapRevCode": "N",
          "DapStoreCode": null,
          "DapTotal1Code": null,
          "DapTotal2Code": null,
          "DapTotalNum": null,
          "DapStartAccCode": "40001",
          "DapStartAccSeq": null,
          "DapEndAccCode": "99999",
          "DapEndAccSeq": null,
          "DapDocName": "Balance Sheet - Consolidated",
          "DapDocCode": "BALANCE",
          "DapDesc": "Profit / (Loss)",
          "DapCon2Code": null,
          "DapCon2Name": null,
          "DapVUuid": "EA02BA025A838811E053B08610ACE770",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldocrows/EA02BA025A838811E053B08610ACE770",
              "name": "gldocrows",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldocrows/EA02BA025A838811E053B08610ACE770",
              "name": "gldocrows",
              "kind": "item"
            }
          ]
        }
      ],
      "totalResults": 101,
      "count": 2,
      "hasMore": true,
      "limit": 2,
      "offset": 0,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestupg/glrestapi/rest/v1/gldocrows",
          "name": "gldocrows",
          "kind": "collection"
        }
      ]
    }
    object