Change request statuses

Construction companies can create their own user-defined statuses for change requests. A change request status is mapped to a workflow type, which controls whether change request lines post to the primary project estimate. A workflow type of none (the default) prevents change request lines from posting. Other workflow types, such as pending change, approved change, and so forth, result in posting.

List change request statuses

get/objects/construction/change-request-status

Returns up to 100 object references from the collection with a key, ID, and link for each change request status. 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": "21",
      • "id": "Not issued",
      • "href": "/objects/construction/change-request-status/21"
      },
    • {
      • "key": "22",
      • "id": "Approved",
      • "href": "/objects/construction/change-request-status/22"
      },
    • {
      • "key": "23",
      • "id": "Original",
      • "href": "/objects/construction/change-request-status/23"
      },
    • {
      • "key": "24",
      • "id": "Revised",
      • "href": "/objects/construction/change-request-status/24"
      },
    • {
      • "key": "25",
      • "id": "Future",
      • "href": "/objects/construction/change-request-status/25"
      }
    ],
  • "ia::meta": {
    • "totalCount": 5,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a change request status
post/objects/construction/change-request-status
Creates a new change request status.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Change request status to create


id
required
string  <= 80 characters 
Unique name or ID for the change request status.


 
 Example:  "Revised"
workflowType
required
string
 Default:  "none"
Workflow type associated with the change request status.


 Enum: "approvedChange" "forecast" "none" "original" "other" "pendingChange" "revision"  
 Example:  "revision"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "id": "Pending",
  • "workflowType": "pendingChange",
  • "status": "active"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "111",
    • "id": "Approved change",
    • "href": "/objects/construction/change-request-status/111"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a change request status
get/objects/construction/change-request-status/{key}
Returns detailed information for a specified change request status.


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


 
 Example:  12
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "Pending",
    • "workflowType": "pendingChange",
    • "status": "active",
    • "audit": {
      • "createdDateTime": "2021-11-11T02:16:46Z",
      • "modifiedDateTime": "2021-11-11T02:16:46Z",
      • "createdBy": "1",
      • "modifiedBy": "1"
      },
    • "href": "/objects/construction/change-request-status/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a change request status
patch/objects/construction/change-request-status/{key}
Updates an existing change request status by setting field values. Any fields not provided remain unchanged.


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


 
 Example:  12
Request Body schema: application/json
workflowType
string
 Default:  "none"
Workflow type associated with the change request status.


 Enum: "approvedChange" "forecast" "none" "original" "other" "pendingChange" "revision"  
 Example:  "revision"
status
string
 Default:  "active"
Object status. Active objects are fully functional. Inactive objects are essentially hidden and cannot be used or referenced.


 Enum: "active" "inactive"  
 Example:  "active"
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "status": "inactive"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "12",
    • "id": "Pending",
    • "href": "/objects/construction/change-request-status/12"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a change request status
delete/objects/construction/change-request-status/{key}
Deletes a change request status.


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


 
 Example:  12
Responses 
204
No Content


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "ia::error": {
      • "code": "invalidRequest",
      • "message": "A POST request requires a payload",
      • "errorId": "REST-1028",
      • "additionalInfo": {
        },
      • "supportId": "Kxi78%7EZuyXBDEGVHD2UmO1phYXDQAAAAo"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 0,
    • "totalError": 1
    }
}