Batch Create Code Types
post
/api/restapi/codeType/batch
Send a request to this endpoint to create one or more code types. An application object will be created for each JSON object provided in the request body.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : List<ApiEntityCodeTypeInput>
Type:
array
Title:
Show Source
List<ApiEntityCodeTypeInput>
-
Array of:
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
Nested 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.
Show Source
- codeTypeId
- codeTypeCode,projectId
- codeTypeCode,projectCode,workspaceCode
- codeTypeCode,workspaceId
- codeTypeCode,workspaceCode
-
assignments: array
assignments
The list of code type assignments.
-
associationType: stringRead Only:true
Allowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 23.11.The type of association in the relationship between the code type and the workspace. Possible values are Owned and Inherited. -
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. -
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. -
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. -
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. -
workspaceId(required): integer
(int64)
The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
Nested Schema : assignments
Type:
array
The list of code type assignments.
Show Source
-
Array of:
object ApiEntityCodeEntityTypeInput
Title:
ApiEntityCodeEntityTypeInput
Nested Schema : ApiEntityCodeEntityTypeInput
Type:
object
Title:
Show Source
ApiEntityCodeEntityTypeInput
-
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. -
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. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : codeType
The unique identifier of a code type.
Match All
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
Examples
Back to Top
Response
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : List<ApiEntityCodeType>
Type:
array
Title:
Show Source
List<ApiEntityCodeType>
-
Array of:
object ApiEntityCodeType
Title:
ApiEntityCodeType
Nested Schema : ApiEntityCodeType
Type:
object
Title:
Show Source
ApiEntityCodeType
-
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.
Nested Schema : assignments
Type:
array
The list of code type assignments.
Show Source
-
Array of:
object ApiEntityCodeEntityType
Title:
ApiEntityCodeEntityType
Nested Schema : ApiEntityCodeEntityType
Type:
object
Title:
Show Source
ApiEntityCodeEntityType
-
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.
Nested Schema : codeType
The unique identifier of a code type.
Match All
Show Source
-
object
ApiEntityCodeType
Title:
ApiEntityCodeType
400 Response
Invalid input for the Code Type service. Verify the request contains valid data, then resubmit the request.