Batch Update Custom Log Type Objects
put
/api/restapi/customLogTypeObject/batch
Send a request to this endpoint to update custom log type objects. 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<ApiEntityCustomLogTypeObjectInput>
Type:
array
Title:
Show Source
List<ApiEntityCustomLogTypeObjectInput>
-
Array of:
object ApiEntityCustomLogTypeObjectInput
Title:
ApiEntityCustomLogTypeObjectInput
This entity represents a CustomLogTypeObject object, a unique CustomLogTypeObject object can be identified by the following combinations of the fields.- customLogTypeObjectId
- customLogTypeObjectName,scope,scopeId
- customLogTypeObjectName,scope,scopeCode,workspaceId
- customLogTypeObjectName,scope,scopeCode,workspaceCode
Nested Schema : ApiEntityCustomLogTypeObjectInput
Type:
object
Title:
ApiEntityCustomLogTypeObjectInput
This entity represents a CustomLogTypeObject object, a unique CustomLogTypeObject object can be identified by the following combinations of the fields.
Show Source
- customLogTypeObjectId
- customLogTypeObjectName,scope,scopeId
- customLogTypeObjectName,scope,scopeCode,workspaceId
- customLogTypeObjectName,scope,scopeCode,workspaceCode
-
appliesTo: array
appliesTo
The list of code type assignments.
-
assignedWorkspaceCode: stringRead Only:true
Maximum Length:60
Deprecated. As of 23.12.The user defined identifier of the workspace for which the custom log type belongs. -
assignedWorkspaceId: integer(int64)Read Only:true
Deprecated. As of 23.12.The system generated identifier of the workspace for which the custom log type belongs. -
associationType: stringRead Only:true
Allowed Values:[ "OWNED", "INHERITED" ]
Deprecated. As of 23.12.The type of association between a document and an object. -
customLogTypeCodeTypes: array
customLogTypeCodeTypes
The code types associated with a custom log type object.
-
customLogTypeObjectId: integer
(int64)
The system-generated identifier of custom log type object.
-
customLogTypeObjectName(required): string
Minimum Length:
0
Maximum Length:255
The user-defined identifier of a custom log type object. -
customLogUdfs: array
customLogUdfs
An object containing configured fields in the form of key-value pairs.
-
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. -
ownershipType: stringRead Only:true
Allowed Values:[ "WORKSPACE", "PROJECT", "PROGRAM" ]
Deprecated. As of 23.12.The ownership type of the custom log type object. -
pushDownType: string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
How data is shared between parent and child workspaces.
Manual: Data can be pulled down by child workspaces. This is the default option.
Automatic: Data is automatically shared with all child workspaces. -
scope(required): string
Maximum Length:
40
Allowed Values:[ "project", "program", "workspace" ]
The scope of an object. -
scopeCode: string
Maximum Length:
60
The user-defined identifier of a reference to another object. -
scopeId(required): integer
(int64)
The system-generated identifier of a reference to another object.
-
securityGuid: stringRead Only:true
Maximum Length:32
Deprecated. As of 23.12.The globally unique identifier of an object. -
sequenceNumber: integer(int32)Read Only:true
Deprecated. As of 23.12.The sequence number of an object. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.12.Date when the record was last updated. -
workspaceCode: string
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 : appliesTo
Type:
array
The list of code type assignments.
Show Source
-
Array of:
object ApiEntityCustomLogEntityTypeInput
Title:
ApiEntityCustomLogEntityTypeInput
Nested Schema : customLogTypeCodeTypes
Type:
array
The code types associated with a custom log type object.
Show Source
-
Array of:
object ApiEntityCustomLogTypeCodeTypeInput
Title:
ApiEntityCustomLogTypeCodeTypeInput
Nested Schema : customLogUdfs
Type:
array
An object containing configured fields in the form of key-value pairs.
Show Source
-
Array of:
object ApiEntityCustomLogUdfInput
Title:
ApiEntityCustomLogUdfInput
Nested Schema : ApiEntityCustomLogEntityTypeInput
Type:
object
Title:
Show Source
ApiEntityCustomLogEntityTypeInput
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
customLogEntityTypeId: integer
(int64)
The system-generated identifier of custom log type object and entity association.
-
entityType: string
Allowed Values:
[ "PROGRAM", "PROJECT" ]
Indicates the type of object the custom log type object 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 : ApiEntityCustomLogTypeCodeTypeInput
Type:
object
Title:
Show Source
ApiEntityCustomLogTypeCodeTypeInput
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
-
codeTypeId: integer
(int64)
The system-generated identifier of a code type.
-
customLogTypeCodeTypeId: integer
(int64)
The system-generated identifier of a doc type.
-
customLogTypeObjectId: integer
(int64)
The system-generated identifier of a custom log type object.
-
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. -
workspaceCode: string
Minimum Length:
0
Maximum Length:60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The unique identifier of a workspace.
Nested Schema : ApiEntityCustomLogUdfInput
Type:
object
Title:
Show Source
ApiEntityCustomLogUdfInput
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnLabel: string
Minimum Length:
1
Maximum Length:100
-
columnName: string
Minimum Length:
1
Maximum Length:100
-
customLogObjectId: integer
(int64)
The system-generated identifier of custom log type object.
-
customLogUdfId: integer
(int64)
The system-generated identifier of a code type.
-
fdColumnId: integer
(int64)
The system-generated identifier of a column.
-
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.
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.