View a Custom Log Type Object
get
/primeapi/restapi/customLogTypeObject/{id}
This endpoint returns custom log type objects that meet the following requirements:
- The object has an ID that matches the value of the {id} path parameter.
Request
Path Parameters
-
id: integer(int64)
The system-generated identifier of a custom log type object.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityCustomLogTypeObject
Type:
Show Source
object
-
associationType(optional):
string
Allowed Values:
[ "OWNED", "INHERITED" ]
The type of association between a document and an object. -
customLogTypeCodeTypes(optional):
array customLogTypeCodeTypes
Unique Items Required:
true
The code types associated with a custom log type object. -
customLogTypeName:
string
The name of a custom log type.
-
customLogTypeObjectId(optional):
integer(int64)
The system-generated identifier of an object.
-
customLogUdfs(optional):
array customLogUdfs
Unique Items Required:
true
An object containing configured fields in the form of key-value pairs. -
link(optional):
string(url)
Read Only:
true
-
ownershipType(optional):
string
Allowed Values:
[ "WORKSPACE", "PROJECT" ]
The ownership type of the custom log type object. -
scope:
string
The scope of an object.
-
scopeCode(optional):
string
The user-specified identifier of a scope item.
-
scopeId:
integer(int64)
The system-generated identifier of a reference to another object.
-
securityGuid(optional):
string
The globally unique identifier of an object.
-
sequenceNumber(optional):
integer(int32)
The sequence number of an object.
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response. -
workspaceCode(optional):
string
The user-specified identifier of a workspace.
-
workspaceId:
integer(int64)
The system-generated identifier of a workspace.
Nested Schema : customLogTypeCodeTypes
Type:
array
Unique Items Required:
true
The code types associated with a custom log type object.
Show Source
Nested Schema : customLogUdfs
Type:
array
Unique Items Required:
true
An object containing configured fields in the form of key-value pairs.
Show Source
Nested Schema : ApiEntityCustomLogTypeCodeType
Type:
Show Source
object
-
codeTypeCode(optional):
string
-
codeTypeId(optional):
integer(int64)
The system-generated identifier of a code type.
-
customLogTypeCodeTypeId:
integer(int64)
The system-generated identifier of a doce type. This value should not be provided in create operation request data, however, it is required for update requests.
-
customLogTypeObjectId(optional):
integer(int64)
The system-generated identifier of a document.
-
link(optional):
string(url)
Read Only:
true
-
uniqueName(optional):
string
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
Nested Schema : ApiEntityCustomLogUdf
Type:
Show Source
object
-
columnLabel(optional):
string
-
columnName(optional):
string
Read Only:
true
-
customLogObjectId(optional):
integer(int64)
The system-generated identifier of an object.
-
customLogUdfId(optional):
integer(int64)
The system-generated identifier of a code type. This value should not be provided in create operation request data, however, it is required for update requests.
-
fdColumnId(optional):
integer(int64)
The system-generated identifier of a column.
-
link(optional):
string(url)
Read Only:
true
-
updateDate(optional):
string(date-time)
Read Only:
true
Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
404 Response
The requested object does not exist, or you do not have access to it.