Jump to

• Request
• Response

View Code Types by Associated Object

get

/api/restapi/codeType

This endpoint returns code types that meet the following requirements:

• The object is associated with one or more object types that match the value of the {type} query parameter.

Request

Query Parameters

• type(required): string
  Code EntityType to get Code Types
  This is a required field.

  Allowed Values: [ "ACTIVITY", "COMMITMENT", "CONSTRAINT", "CONTRACT", "CUSTOM_LOG_ITEM", "FUND", "IDEA", "PBS", "PORTFOLIO", "PROGRAM", "PROJECT", "REPORT", "RESOURCE", "RFI", "RISK", "SCOPE_ASSIGNMENT", "SCOPE_ITEM", "STRATEGY", "SUBMITTAL", "TASKS", "WBS", "WORK_PACKAGE" ]

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityCodeType>

Type: array

Title: List<ApiEntityCodeType>

Show Source

• Array of: object ApiEntityCodeType
  Title: ApiEntityCodeType

{
    "title":"List<ApiEntityCodeType>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeType",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCodeType

Type: object

Title: ApiEntityCodeType

Show Source

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

{
    "title":"ApiEntityCodeType",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the workspace code.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the code type and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"Displays the code or ID of the Code Type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "assignments":{
            "type":"array",
            "description":"The list of code type assignments.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeEntityType",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : assignments

Type: array

The list of code type assignments.

Show Source

• Array of: object ApiEntityCodeEntityType
  Title: ApiEntityCodeEntityType

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

Nested Schema : ApiEntityCodeEntityType

Type: object

Title: ApiEntityCodeEntityType

Show Source

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

{
    "title":"ApiEntityCodeEntityType",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeType":{
            "description":"The unique identifier of a code type.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityCodeType"
                }
            ]
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : codeType

The unique identifier of a code type.

Match All

Show Source

• object ApiEntityCodeType
  Title: ApiEntityCodeType

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

404 Response

The requested code type does not exist, or you do not have access to it.

Back to Top