Contents x
Retrieve GT Texts By Code
  • 25 Sep 2024
  • 4 Minutes to read
  • Print
  • Dark
    Light
Contents

Retrieve GT Texts By Code

  • Updated on 25 Sep 2024
  • 4 Minutes to read
  • Print
  • Dark
    Light
Article summary

Get
/sys-rest-api/rest/1/gttext

Query Standards

Finder

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

  • Select by Company Type
  • Select by Primary Key
  • Select By Audit Date

Select by Company Type

Recommended finder parameters. Refer to Query Parameters for example.

Parameter Description Example Value
compCode Company code 001
typeCode Type of company (e.g., PURCH for purchase) PURCH

Select by Primary Key

This optional finder is used to retrieve GT Texts using a combination of Text Code and Company Code as primary keys.

Parameter Description Example Value
TxtCode Text Code ACC
TxtCompCode Company Code 001

Select by Audit Date

This optional finder is used to retrieve GT Texts based on a specific Audit Date.

Parameter Description Example Value
auditDate Create or update date time filter 2015-04-01
Security
HTTP
Type basic

Basic authentication

Query parameters
finder
string
ExamplefindByCompType;compCode=001, typeCode=PURCH
limit
integer
Example500
offset
integer
Example0
totalResults
boolean
Exampletrue
orderBy
string
ExampleTxtCode:desc
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
example-0

Successful Response - FInder - selectByDate

{
  "items": [
    {
      "TxtCode": "ACC",
      "TxtDesc": "Accounting Copy",
      "TxtCompCode": "001",
      "TxtCompName": "CMiC Construction Inc",
      "TxtTypeCode": "PURCH",
      "TxtPrintDesc": "Purchasing",
      "TxtPrintOrderNum": 1,
      "TxtTrionTerminateReasonCde": null,
      "TxtIuCreateDate": "2015-04-16T03:02:50Z",
      "TxtIuCreateUser": "ADWAIT",
      "TxtIuUpdateDate": null,
      "TxtIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/00020000000341434300000003303031",
          "name": "gttext",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/00020000000341434300000003303031",
          "name": "gttext",
          "kind": "item"
        }
      ]
    },
    {
      "TxtCode": "DC",
      "TxtDesc": "Data Correction",
      "TxtCompCode": "001",
      "TxtCompName": "CMiC Construction Inc",
      "TxtTypeCode": "PY",
      "TxtPrintDesc": "Payroll",
      "TxtPrintOrderNum": 7,
      "TxtTrionTerminateReasonCde": null,
      "TxtIuCreateDate": "2015-04-16T03:02:50Z",
      "TxtIuCreateUser": "ADWAIT",
      "TxtIuUpdateDate": null,
      "TxtIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/000200000002444300000003303031",
          "name": "gttext",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/000200000002444300000003303031",
          "name": "gttext",
          "kind": "item"
        }
      ]
    },
    {
      "TxtCode": "EVANSC1",
      "TxtDesc": "SUBCONTRACTOR'S REQUEST FOR PAYMENT\n        INTERIM WAIVER OF CLAIM AND LIEN & CERTIFICATION OF PREVIOUS PAYMENTS",
      "TxtCompCode": "001",
      "TxtCompName": "CMiC Construction Inc",
      "TxtTypeCode": "WAEVANS",
      "TxtPrintDesc": "Interim Waiver for EVANSC",
      "TxtPrintOrderNum": 1,
      "TxtTrionTerminateReasonCde": null,
      "TxtIuCreateDate": "2018-12-16T03:53:50Z",
      "TxtIuCreateUser": "DA",
      "TxtIuUpdateDate": null,
      "TxtIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/0002000000074556414E53433100000003303031",
          "name": "gttext",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/0002000000074556414E53433100000003303031",
          "name": "gttext",
          "kind": "item"
        }
      ]
    },
    {
      "TxtCode": "EVANSC2",
      "TxtDesc": "FROM: <>\n\nPROJECT: <> <>        APPL FOR PAYMENT # : <>\n\nSUBCONTRACT #: <>          WORK PERFORMED THRU: <>",
      "TxtCompCode": "001",
      "TxtCompName": "CMiC Construction Inc",
      "TxtTypeCode": "WAEVANS",
      "TxtPrintDesc": "Interim Waiver for EVANSC",
      "TxtPrintOrderNum": 2,
      "TxtTrionTerminateReasonCde": null,
      "TxtIuCreateDate": "2018-12-16T03:53:50Z",
      "TxtIuCreateUser": "DA",
      "TxtIuUpdateDate": null,
      "TxtIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/0002000000074556414E53433200000003303031",
          "name": "gttext",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/0002000000074556414E53433200000003303031",
          "name": "gttext",
          "kind": "item"
        }
      ]
    },
    {
      "TxtCode": "EVANSC3",
      "TxtDesc": "CERTIFICATE OF THE SUBCONTRACTOR",
      "TxtCompCode": "001",
      "TxtCompName": "CMiC Construction Inc",
      "TxtTypeCode": "WAEVANS",
      "TxtPrintDesc": "Interim Waiver for EVANSC",
      "TxtPrintOrderNum": 3,
      "TxtTrionTerminateReasonCde": null,
      "TxtIuCreateDate": "2018-12-16T03:53:50Z",
      "TxtIuCreateUser": "DA",
      "TxtIuUpdateDate": null,
      "TxtIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/0002000000074556414E53433300000003303031",
          "name": "gttext",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/0002000000074556414E53433300000003303031",
          "name": "gttext",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 5,
  "hasMore": true,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext",
      "name": "gttext",
      "kind": "collection"
    }
  ]
}
example-1

Successful Response - FInder - PrimaryKey

{
  "items": [
    {
      "TxtCode": "ACC",
      "TxtDesc": "Accounting Copy",
      "TxtCompCode": "001",
      "TxtCompName": "CMiC Construction Inc",
      "TxtTypeCode": "PURCH",
      "TxtPrintDesc": "Purchasing",
      "TxtPrintOrderNum": 1,
      "TxtTrionTerminateReasonCde": null,
      "TxtIuCreateDate": "2015-04-16T03:02:50Z",
      "TxtIuCreateUser": "ADWAIT",
      "TxtIuUpdateDate": null,
      "TxtIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/00020000000341434300000003303031",
          "name": "gttext",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/00020000000341434300000003303031",
          "name": "gttext",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext",
      "name": "gttext",
      "kind": "collection"
    }
  ]
}
example-2

Successful Response - FInder - selectByCompType

{
  "items": [
    {
      "TxtCode": "ACC",
      "TxtDesc": "Accounting Copy",
      "TxtCompCode": "001",
      "TxtCompName": "CMiC Construction Inc",
      "TxtTypeCode": "PURCH",
      "TxtPrintDesc": "Purchasing",
      "TxtPrintOrderNum": 1,
      "TxtTrionTerminateReasonCde": null,
      "TxtIuCreateDate": "2015-04-16T03:02:50Z",
      "TxtIuCreateUser": "ADWAIT",
      "TxtIuUpdateDate": null,
      "TxtIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/00020000000341434300000003303031",
          "name": "gttext",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/00020000000341434300000003303031",
          "name": "gttext",
          "kind": "item"
        }
      ]
    },
    {
      "TxtCode": "FILE",
      "TxtDesc": "File Copy",
      "TxtCompCode": "001",
      "TxtCompName": "CMiC Construction Inc",
      "TxtTypeCode": "PURCH",
      "TxtPrintDesc": "Purchasing",
      "TxtPrintOrderNum": 3,
      "TxtTrionTerminateReasonCde": null,
      "TxtIuCreateDate": "2015-04-16T03:02:50Z",
      "TxtIuCreateUser": "ADWAIT",
      "TxtIuUpdateDate": null,
      "TxtIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/00020000000446494C4500000003303031",
          "name": "gttext",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/00020000000446494C4500000003303031",
          "name": "gttext",
          "kind": "item"
        }
      ]
    },
    {
      "TxtCode": "PO#",
      "TxtDesc": "Ensure PO Number is shown on invoice",
      "TxtCompCode": "001",
      "TxtCompName": "CMiC Construction Inc",
      "TxtTypeCode": "PURCH",
      "TxtPrintDesc": "Purchasing",
      "TxtPrintOrderNum": 1,
      "TxtTrionTerminateReasonCde": null,
      "TxtIuCreateDate": "2015-04-16T03:02:50Z",
      "TxtIuCreateUser": "ADWAIT",
      "TxtIuUpdateDate": null,
      "TxtIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/000200000003504F2300000003303031",
          "name": "gttext",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/000200000003504F2300000003303031",
          "name": "gttext",
          "kind": "item"
        }
      ]
    },
    {
      "TxtCode": "VNDR",
      "TxtDesc": "Vendor Copy",
      "TxtCompCode": "001",
      "TxtCompName": "CMiC Construction Inc",
      "TxtTypeCode": "PURCH",
      "TxtPrintDesc": "Purchasing",
      "TxtPrintOrderNum": 2,
      "TxtTrionTerminateReasonCde": null,
      "TxtIuCreateDate": "2015-04-16T03:02:50Z",
      "TxtIuCreateUser": "ADWAIT",
      "TxtIuUpdateDate": null,
      "TxtIuUpdateUser": null,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/000200000004564E445200000003303031",
          "name": "gttext",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext/000200000004564E445200000003303031",
          "name": "gttext",
          "kind": "item"
        }
      ]
    }
  ],
  "count": 4,
  "hasMore": false,
  "limit": 5,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/gttext",
      "name": "gttext",
      "kind": "collection"
    }
  ]
}
object
What's Next
Contact Us
Copyright © 2024 CMiC All Rights Reserved