Retrieve JB Groups By Code
- 20 Mar 2024
- 1 Minute to read
- Print
- DarkLight
Retrieve JB Groups By Code
- Updated on 20 Mar 2024
- 1 Minute to read
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
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.
| Parameter | Description | Sample |
|---|---|---|
| GroupCode | Group Code | 15100 |
| CompCode | Company Code | 001 |
| ContCode | Contract Code | 00100 |
| GroupNum | Group Number | 1 |
By UUID
This is an optional finder for querying a specific Job Billing Group by row ID.
| Parameter | Description | Sample |
|---|---|---|
| /VUUID | The 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
{
"items": [
{
"JbgCompCode": "001",
"JbgContCode": "00100",
"JbgGroupNum": 1,
"JbgGroupCode": "15100",
"JbgName": "Building Services Piping",
"JbgGroupMaxBillingAmt": null,
"JbgGroupPremiumSplitFlag": "N",
"JbgIuCreateDate": "2016-09-21T20: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