View a Code Value
get
/api/restapi/codeValue/{codeValueId}
This endpoint returns code values that meet the following requirements:
- The object has an ID that matches the value of the {codeValueId} path parameter.
Request
Path Parameters
-
codeValueId(required): integer(int64)
ID of the Code Value to be loaded.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityCodeValue
Type:
object
Title:
Show Source
ApiEntityCodeValue
-
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId: integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeTypeName: string
Maximum Length:
255
The name of a code or value. -
codeValueCode: string
Minimum Length:
0
Maximum Length:60
The unique identifier for the code value. -
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
0
Maximum Length:255
The name of the code value. -
color: string
Maximum Length:
255
A color for the code value.
The hexadecimal color code (in lower case) are the allowed values for this field.
Example: #00008B -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentCodeValueCode: string
Minimum Length:
0
Maximum Length:60
The parent code value code of a code value. -
parentCVCodes: array
parentCVCodes
List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of the project of a project code type associated with the code value. -
sequenceNumber: integer
(int32)
The number that specifies the position of the code value item within the code type list.
-
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.
Nested Schema : parentCVCodes
Type:
array
List of parent code values in a hierarchy. This field is not populated as part of the API response since it is a write-only field, used only for the create or update APIs.
Show Source
404 Response
The requested code value does not exist, or you do not have access to it.