Get Activity Code Type

GET /public/v1/projects/{projectId}/activity-code-type/{activityCodeTypeId}

Api key

Headers

X-COMPANY-ID string Required

The company's unique ID

Path parameters

projectId integer(int64) Required
activityCodeTypeId integer(int64) Required

Responses

500 */*

Internal Server Error
200 */*

OK
Hide response attributes Show response attributes object
- id integer(int64) Required
  
  The unique identifier of the activity code type
- externalProjectId integer(int32) Required
  
  The external project ID associated with the activity code type
- sequenceNumber integer(int32) Required
  
  The sequence number of the activity code type
- secureCode boolean Required
  
  Indicates if the activity code type is secure
- length integer(int32) Required
  
  The length of the activity code type
- name string Required
  
  The name of the activity code type
- scope string Required
  
  The scope of the activity code type
- epsId integer(int32) Required
  
  The EPS ID associated with the activity code type
- epsNumber integer(int32) Required
  
  The EPS number associated with the activity code type
- activityCodes array[object] Required
  
  List of activity codes associated with the activity code type
  
  Activity Code Response
  
  Hide activityCodes attributes Show activityCodes attributes object
  
  id integer(int64) Required
  
  The unique identifier of the activity code
  
  parent object Required
  
  The parent activity code
  
  Hide parent attribute Show parent attribute object
  
  id Required
  
  value string Required
  
  The value of the activity code
  
  desc string Required
  
  The description of the activity code
  
  sequenceNumber integer(int32) Required
  
  The sequence number of the activity code
  
  order integer(int32) Required
  
  The order of the activity code
  
  children array[object] Required
  
  List of child activity codes
  
  Activity Code Response
  
  Hide children attributes Show children attributes object
  
  desc Required
  
  id Required
  
  order Required
  
  parent Required
  
  sequenceNumber Required
  
  value Required

GET /public/v1/projects/{projectId}/activity-code-type/{activityCodeTypeId}

curl \
 --request GET 'https://live.smartpmtech.com/public/v1/projects/{projectId}/activity-code-type/{activityCodeTypeId}' \
 --header "X-API-KEY: $API_KEY" \
 --header "X-COMPANY-ID: string"

Response examples (500)

{}

Response examples (200)

{
  "id": 1,
  "externalProjectId": 1001,
  "sequenceNumber": 10,
  "secureCode": true,
  "length": 5,
  "name": "Labor",
  "scope": "Project",
  "epsId": 2001,
  "epsNumber": 3001,
  "activityCodes": [
    {
      "id": 1,
      "parent": {},
      "value": "AC123",
      "desc": "This is an activity code description.",
      "sequenceNumber": 10,
      "order": 1,
      "children": [
        {}
      ]
    }
  ]
}