View a Custom Log Type Object
get
/api/restapi/customLogTypeObject/{customLogTypeObjectId}
This endpoint returns custom log type objects that meet the following requirements:
- The object has an ID that matches the value of the {customLogTypeObjectId} path parameter.
Request
Path Parameters
-
customLogTypeObjectId(required): integer(int64)
The system-generated identifier of a custom log type object.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : ApiEntityCustomLogTypeObject
Type:
object
Title:
Show Source
ApiEntityCustomLogTypeObject
-
appliesTo: array
appliesTo
The list of code type assignments.
-
assignedWorkspaceCode: string
Maximum Length:
60
The user defined identifier of the workspace for which the custom log type belongs. -
assignedWorkspaceId: integer
(int64)
The system generated identifier of the workspace for which the custom log type belongs.
-
associationType: string
Allowed Values:
[ "OWNED", "INHERITED" ]
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: 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)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
ownershipType: string
Allowed Values:
[ "WORKSPACE", "PROJECT", "PROGRAM" ]
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: 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: integer
(int64)
The system-generated identifier of a reference to another object.
-
securityGuid: string
Maximum Length:
32
The globally unique identifier of an object. -
sequenceNumber: integer
(int32)
The sequence number of an object.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
workspaceCode: string
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 : appliesTo
Type:
array
The list of code type assignments.
Show Source
-
Array of:
object ApiEntityCustomLogEntityType
Title:
ApiEntityCustomLogEntityType
Nested Schema : customLogTypeCodeTypes
Type:
array
The code types associated with a custom log type object.
Show Source
-
Array of:
object ApiEntityCustomLogTypeCodeType
Title:
ApiEntityCustomLogTypeCodeType
Nested Schema : customLogUdfs
Type:
array
An object containing configured fields in the form of key-value pairs.
Show Source
-
Array of:
object ApiEntityCustomLogUdf
Title:
ApiEntityCustomLogUdf
Nested Schema : ApiEntityCustomLogEntityType
Type:
object
Title:
Show Source
ApiEntityCustomLogEntityType
-
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
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
Date when the record was last updated.
Nested Schema : ApiEntityCustomLogTypeCodeType
Type:
object
Title:
Show Source
ApiEntityCustomLogTypeCodeType
-
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)
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.
-
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 : ApiEntityCustomLogUdf
Type:
object
Title:
Show Source
ApiEntityCustomLogUdf
-
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)
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.
404 Response
The requested object does not exist, or you do not have access to it.