Retrieve JB Groups By Code
    • 04 Dec 2024
    • 1 Minute to read
    • Dark
      Light

    Retrieve JB Groups By Code

    • Dark
      Light

    Article summary

    Get
    /jb-rest-api/rest/1/jbgroup

    Query Standards

    Finder

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

    • Select By Code
    • By UUID

    Select By Code

    Recommended finder parameters. Refer to Query Parameters for example.

    ParameterDescriptionSample
    GroupCodeGroup Code15100
    CompCodeCompany Code001
    ContCodeContract Code00100
    GroupNumGroup Number1

    By UUID

    This is an optional finder for querying a specific Job Billing Group by row ID.

    ParameterDescriptionSample
    /VUUIDThe VUuid attribute is the Unique row ID/jb-rest-api/rest/1/jbgroup/E7C9D29DA1302E6CE05316821FAC2D6C
    Security
    HTTP
    Type basic

    Basic authentication

    Query parameters
    finder
    string
    ExampleselectByCode;GroupCode=15100,CompCode=001,ContCode=00100,GroupNum=1
    limit
    integer
    Example500
    offset
    integer
    Example0
    totalResults
    boolean
    ExampleTrue
    orderBy
    string
    ExampleJbgVUuid:desc
    Responses
    200

    OK

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourcecollection+json
    {
      "items": [
        {
          "JbgCompCode": "001",
          "JbgContCode": "00100",
          "JbgGroupNum": 1,
          "JbgGroupCode": "15100",
          "JbgName": "Building Services Piping",
          "JbgGroupMaxBillingAmt": null,
          "JbgGroupPremiumSplitFlag": "N",
          "JbgIuCreateDate": "2016-09-21T08:11:09Z",
          "JbgIuUpdateDate": null,
          "JbgVUuid": "E7C9D29DA1302E6CE05316821FAC2D6C",
          "links": [
            {
              "rel": "self",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jb-rest-api/rest/1/jbgroup/E7C9D29DA1302E6CE05316821FAC2D6C",
              "name": "jbgroup",
              "kind": "item"
            },
            {
              "rel": "canonical",
              "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jb-rest-api/rest/1/jbgroup/E7C9D29DA1302E6CE05316821FAC2D6C",
              "name": "jbgroup",
              "kind": "item"
            }
          ]
        }
      ],
      "count": 1,
      "hasMore": false,
      "limit": 5,
      "offset": 0,
      "links": [
        {
          "rel": "self",
          "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/jb-rest-api/rest/1/jbgroup",
          "name": "jbgroup",
          "kind": "collection"
        }
      ]
    }
    object