View a Code Type by Code
get
/api/restapi/codeType/byItemCode
Send a request to this endpoint to view a code type with codes matching the code fields in query parameters.
Request
Query Parameters
-
codeTypeCode(required): string
The user specified Identifier of the code type to be found.
This is a required field. -
workspaceCode(required): string
workspace code of the code type to be found.
This is a required field.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityCodeType
Type:
object
Title:
Show Source
ApiEntityCodeType
-
assignments: array
assignments
The list of code type assignments.
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association in the relationship between the code type and the workspace. Possible values are Owned and Inherited. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
Displays the code or ID of the Code Type. -
codeTypeId: integer
(int64)
The system-generated identifier of a code type.
-
codeTypeName: string
Minimum Length:
0
Maximum Length:255
The name of a code or value. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of a Project of a Project CodeType. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace code. -
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Nested Schema : assignments
Type:
array
The list of code type assignments.
Show Source
-
Array of:
object ApiEntityCodeEntityType
Title:
ApiEntityCodeEntityType
Nested Schema : ApiEntityCodeEntityType
Type:
object
Title:
Show Source
ApiEntityCodeEntityType
-
codeType:
codeType
The unique identifier of a code type.
-
entityType: string
Maximum Length:
60
Allowed Values:[ "ACTIVITY", "CONSTRAINT", "CUSTOM_LOG_ITEM", "DOCUMENT", "FUND", "IDEA", "PBS", "PORTFOLIO", "PROGRAM", "PROJECT", "REPORT", "RESOURCE", "RISK", "SCOPE_ASSIGNMENT", "SCOPE_ITEM", "STRATEGY", "TASKS", "WBS", "WORK_PACKAGE" ]
Indicates the type of object the code is associated to. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
updateDate: string
(date-time)
Date when the record was last updated.
Nested Schema : codeType
The unique identifier of a code type.
Match All
Show Source
-
object
ApiEntityCodeType
Title:
ApiEntityCodeType
404 Response
The requested object does not exist, or you do not have access to it.