Batch Update Code Values
put
/api/restapi/codeValue/batch
Send a request to this endpoint to update one or more code values. For each JSON object provided in the request body, an application object with a matching ID value will be updated to reflect the JSON contents.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityCodeValueInput>
Type:
array
Title:
Show Source
List<ApiEntityCodeValueInput>
-
Array of:
object ApiEntityCodeValueInput
Title:
ApiEntityCodeValueInput
This entity represents a CodeValue object, a unique CodeValue object can be identified by the following combinations of the fields.- codeValueId
- codeValueCode,codeTypeId
- codeValueCode,codeTypeCode,projectCode,workspaceCode
- codeValueCode,codeTypeCode,workspaceCode
Nested Schema : ApiEntityCodeValueInput
Type:
object
Title:
ApiEntityCodeValueInput
This entity represents a CodeValue object, a unique CodeValue object can be identified by the following combinations of the fields.
Show Source
- codeValueId
- codeValueCode,codeTypeId
- codeValueCode,codeTypeCode,projectCode,workspaceCode
- codeValueCode,codeTypeCode,workspaceCode
-
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): 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(required): 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(required): 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)Read Only:true
Deprecated. As of 23.10.The self-link to the object. This field is populated only in the responses generated by the batch create APIs. -
parentCodeValueCode: stringRead Only:true
Minimum Length:0
Maximum Length:60
Deprecated. As of 24.3.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)Read Only:true
Deprecated. As of 23.10.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
Examples
Back to Top
Response
200 Response
A collection of object IDs mapped to a canonical link of the object. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"}}
400 Response
Invalid input for the Code Value service.