Jump to

• Request
• Response

Update a Code Value

put

/api/restapi/codeValue

Send a request to this endpoint to update a code value. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root 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.

• codeValueId
• codeValueCode,codeTypeId
• codeValueCode,codeTypeCode,projectCode,workspaceCode
• codeValueCode,codeTypeCode,workspaceCode

Show Source

• 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: string
  Read 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.

{
    "title":"ApiEntityCodeValueInput",
    "required":[
        "codeTypeId",
        "codeValueCode",
        "codeValueName"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "color":{
            "maxLength":"255",
            "type":"string",
            "description":"A color for the code value.<br />The hexadecimal color code (in lower case) are the allowed values for this field.<br /> Example: #00008B",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The code of the project of a project code type associated with the code value. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentCodeValueCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.3</i>.</br>The parent code value code of a code value.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentCVCodes":{
            "type":"array",
            "description":"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.",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValue object, a unique CodeValue object can be identified by the following combinations of the fields.<ul><li>codeValueId</li><li>codeValueCode,codeTypeId</li><li>codeValueCode,codeTypeCode,projectCode,workspaceCode</li><li>codeValueCode,codeTypeCode,workspaceCode</li>",
    "exampleSetFlag":false
}

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

• Array of: string

{
    "type":"array",
    "description":"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.",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

Examples

Select an example Update a Code Value Using Code Value ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Code Value service.

Back to Top