Jump to

• Request
• Response

Update a Code Type

put

/api/restapi/codeType

Send a request to this endpoint to update a code type. 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 : ApiEntityCodeTypeInput

Type: object

Title: ApiEntityCodeTypeInput

This entity represents a CodeType object, a unique CodeType object can be identified by the following combinations of the fields.

• codeTypeId
• codeTypeCode,projectId
• codeTypeCode,projectCode,workspaceCode
• codeTypeCode,workspaceId
• codeTypeCode,workspaceCode

Show Source

• assignments: array assignments
  The list of code type assignments.
• codeTypeCode(required): 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(required): string
  Minimum Length: 0

  Maximum Length: 255

  The name of a code or value.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a Project of a Project CodeType.
• projectId(required): 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.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityCodeTypeInput",
    "required":[
        "codeTypeCode",
        "codeTypeName",
        "projectId",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "assignments":{
            "type":"array",
            "description":"The list of code type assignments.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeEntityTypeInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the workspace code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeTypeCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"Displays the code or ID of the Code Type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeType object, a unique CodeType object can be identified by the following combinations of the fields.<ul><li>codeTypeId</li><li>codeTypeCode,projectId</li><li>codeTypeCode,projectCode,workspaceCode</li><li>codeTypeCode,workspaceId</li><li>codeTypeCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : assignments

Type: array

The list of code type assignments.

Show Source

• Array of: object ApiEntityCodeEntityTypeInput
  Title: ApiEntityCodeEntityTypeInput

{
    "type":"array",
    "description":"The list of code type assignments.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeEntityTypeInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeEntityTypeInput

Type: object

Title: ApiEntityCodeEntityTypeInput

Show Source

• codeType(required): codeType
  The unique identifier of a code type.
• entityType(required): 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.

{
    "title":"ApiEntityCodeEntityTypeInput",
    "required":[
        "codeType",
        "entityType"
    ],
    "type":"object",
    "properties":{
        "codeType":{
            "description":"The unique identifier of a code type.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityCodeTypeInput"
                }
            ]
        },
        "entityType":{
            "maxLength":60,
            "type":"string",
            "description":"Indicates the type of object the code is associated to.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVITY",
                "CONSTRAINT",
                "CUSTOM_LOG_ITEM",
                "DOCUMENT",
                "FUND",
                "IDEA",
                "PBS",
                "PORTFOLIO",
                "PROGRAM",
                "PROJECT",
                "REPORT",
                "RESOURCE",
                "RISK",
                "SCOPE_ASSIGNMENT",
                "SCOPE_ITEM",
                "STRATEGY",
                "TASKS",
                "WBS",
                "WORK_PACKAGE"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : codeType

The unique identifier of a code type.

Match All

The unique identifier of a code type.

Show Source

• object ApiEntityCodeTypeInput
  Title: ApiEntityCodeTypeInput

  This entity represents a CodeType object, a unique CodeType object can be identified by the following combinations of the fields.

  • codeTypeId
  • codeTypeCode,projectId
  • codeTypeCode,projectCode,workspaceCode
  • codeTypeCode,workspaceId
  • codeTypeCode,workspaceCode

{
    "description":"The unique identifier of a code type.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityCodeTypeInput"
        }
    ]
}

Examples

Select an example Update a Code Type Using Code Type ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request.

Back to Top