Change request lines

Change request lines describe the specific changes in a change request. Change request lines can only be added, updated, and deleted through the owning change-request object.

List change request lines

get/objects/construction/change-request-line

Returns up to 100 object references from the collection with a key, ID, and link for each change request line. This operation is mostly for use in testing; use the query service to find objects that meet certain criteria and to specify properties that are returned.

SecurityOAuth2
Responses
200

OK

400

Bad Request

Request samples 
Response samples 
application/json
{
  • "ia::result": [
    • {
      • "key": "1",
      • "id": "1",
      • "href": "/objects/construction/change-request-line/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/construction/change-request-line/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/construction/change-request-line/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": 0,
    • "previous": 0
    }
}
Get a change request line
get/objects/construction/change-request-line/{key}
Returns detailed information for a specified change request line.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for the change request line.


 
 Example:  99
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "7",
    • "id": "7",
    • "changeRequest": {
      • "key": "11",
      • "id": "REST-CR-02",
      • "href": "/objects/construction/change-request/11"
      },
    • "workflowType": "none",
    • "dimensions": {
      • "location": {
        },
      • "department": {
        },
      • "project": {
        },
      • "customer": {
        },
      • "vendor": {
        },
      • "employee": {
        },
      • "item": {
        },
      • "class": {
        },
      • "task": {
        },
      • "costType": {
        }
      },
    • "numberOfProductionUnits": "1200",
    • "productionUnitDescription": "sqft",
    • "quantity": "5.00",
    • "externalUOM": "each",
    • "unitCost": "32.00",
    • "cost": "160.00",
    • "unitPrice": "40.00",
    • "price": "200.00",
    • "priceMarkupPercent": "10.00",
    • "priceMarkupAmount": "20.00",
    • "linePrice": "220.00",
    • "projectChangeOrder": {
      • "key": "2",
      • "id": "PCO2-DIMBTI",
      • "href": "/objects/construction/project-change-order/2"
      },
    • "memo": "CR Line 02",
    • "projectEstimate": {
      • "key": "1",
      • "id": "BTI-01",
      • "href": "/objects/construction/project-estimate/1"
      },
    • "glAccount": {
      • "key": "35",
      • "id": "5001",
      • "name": "Construction",
      • "href": "/objects/general-ledger/account/35"
      },
    • "projectContract": {
      • "key": "4",
      • "id": "PCN-04",
      • "name": "Construction",
      • "href": "/objects/construction/project-contract/4"
      },
    • "projectContractLine": {
      • "key": "6",
      • "id": "PCL-06",
      • "name": "Construction",
      • "href": "/objects/construction/project-contract-line/6"
      },
    • "lineNo": "1",
    • "audit": {
      • "createdDateTime": "2023-06-14T13:56:42Z",
      • "modifiedDateTime": "2023-06-14T13:56:43Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/construction/change-request-line/7"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}