Cost type observed percent completed

A personal estimation of how complete a cost type is as of a specific date. It is used to track percent completion values and dates by entering "as of dates" and percentages as the cost type progresses.

List observed percent completed

get/objects/construction/cost-type-observed-percent-completed

Returns up to 100 object references from the collection with a key, ID, and link for each cost type observed percent completed. This operation is mostly for use in testing; use query 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/cost-type-observed-percent-completed/1"
      },
    • {
      • "key": "2",
      • "id": "2",
      • "href": "/objects/construction/cost-type-observed-percent-completed/2"
      },
    • {
      • "key": "3",
      • "id": "3",
      • "href": "/objects/construction/cost-type-observed-percent-completed/3"
      }
    ],
  • "ia::meta": {
    • "totalCount": 3,
    • "start": 1,
    • "pageSize": 100,
    • "next": null,
    • "previous": null
    }
}
Create a cost type observed percent completed
post/objects/construction/cost-type-observed-percent-completed
Creates a new cost type observed percent completed.


SecurityOAuth2 
Request 
Request Body schema: application/json
required
Cost type observed percent completed


required
object
Cost type that this observed percent completed entry applies to.


 
key
string
Cost type key.


 
 Example:  "14"
id
string
Cost type ID.


 
 Example:  "EQ-Rental"
asOfDate
required
string <date> 
Observation date.


 
 Example:  "2024-05-05"
percentComplete
required
string <decimal-precision-2> 
Percent completed by the asOfDate.


 
 Example:  "25"
notes
string
Note for the completion entry.


 
 Example:  "Signed off by J.Manager"
Responses 
201
Created


400
Bad Request


Request samples 
application/json
{
  • "costType": {
    • "key": "14"
    },
  • "asOfDate": "2024-06-21",
  • "percentComplete": "20",
  • "notes": "Initial work completed"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "href": "/objects/construction/cost-type-observed-percent-completed/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Get a cost type observed percent completed
get/objects/construction/cost-type-observed-percent-completed/{key}
Returns detailed information for a specified cost type observed percent completed.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for a cost type observed percent completed.


 
 Example:  1
Responses 
200
OK


400
Bad Request


Request samples 
Response samples 
application/json
{
  • "ia::result": {
    • "key": "24",
    • "id": "24",
    • "href": "/objects/construction/cost-type-observed-percent-completed/24",
    • "costType": {
      • "id": "EQ-Rental",
      • "key": "14",
      • "name": "EQ-Rental",
      • "href": "/objects/construction/cost-type/13"
      },
    • "asOfDate": "2024-06-21",
    • "percentComplete": "10",
    • "notes": "Completion on 06/21/24",
    • "audit": {
      • "createdDateTime": "2023-11-11T16:20:00Z",
      • "modifiedDateTime": "2023-11-11T16:20:00Z",
      • "createdBy": "1",
      • "modifiedBy": "95"
      }
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Update a cost type observed percent completed
patch/objects/construction/cost-type-observed-percent-completed/{key}
Updates an existing cost type observed percent completed by setting field values. Any fields not provided remain unchanged.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for a cost type observed percent completed.


 
 Example:  1
Request Body schema: application/json
asOfDate
string <date> 
Observation date.


 
 Example:  "2024-05-05"
percentComplete
string <decimal-precision-2> 
Percent completed by the asOfDate.


 
 Example:  "25"
notes
string
Note for the completion entry.


 
 Example:  "Signed off by J.Manager"
object
Cost type that this observed percent completed entry applies to.


 
Responses 
200
OK


400
Bad Request


Request samples 
application/json
{
  • "percentComplete": "35",
  • "notes": "changed to 35%"
}
Response samples 
application/json
{
  • "ia::result": {
    • "key": "1",
    • "id": "1",
    • "href": "/objects/construction/cost-type-observed-percent-completed/1"
    },
  • "ia::meta": {
    • "totalCount": 1,
    • "totalSuccess": 1,
    • "totalError": 0
    }
}
Delete a cost type observed percent completed
delete/objects/construction/cost-type-observed-percent-completed/{key}
Deletes a cost type observed percent completed.


SecurityOAuth2 
Request 
path Parameters
key
required
string
System-assigned unique key for a cost type observed percent completed.


 
 Example:  1
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
    }
}
Query cost type observed percent completeds
post/services/core/query
Use the query service to find cost type observed percent completeds that meet certain criteria and to specify the properties that are returned.


SecurityOAuth2 
Responses 
200
OK


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
    }
}