View a Custom Log Item by Parent and Code
get
/primeapi/restapi/customLogItem/workspace/{worksaceCode}/project/{projectCode}/customLogObject/{customLogObjectName}/code/{customLogItemCode}
This endpoint returns custom log items that meet the following requirements:
- The object has a code that matches the value of the {code} path parameter.
Request
Path Parameters
-
customLogItemCode: string
The user-specified identifier of a custom log item.
-
customLogObjectName: string
The name of a custom log item.
-
projectCode: string
The user-specified identifier of a project.
-
worksaceCode: string
The user-specified identifier of a workspace.
Response
Supported Media Types
- application/json
200 Response
successful operation
Root Schema : ApiEntityCustomLogItem
Type:
Show Source
object
-
ballInCourtId(optional):
integer(int64)
The system-generated identifier of a user.
-
ballInCourtUserName(optional):
string
The name of a user.
-
codeValues(optional):
array codeValues
Unique Items Required:
true
The categories assigned to the custom log item. -
comment(optional):
string
Notes about the document.
-
customLogsItemId(optional):
integer(int64)
The system-generated identifier of a document.
-
customLogsItemName:
string
The name of the document.
-
customLogTypeObjectId(optional):
integer(int64)
The system-generated identfier of an object.
-
customLogTypeObjectName(optional):
string
The user-specified identifier of a custom log type.
-
dueDate(optional):
string(date-time)
The date the document is due.
-
itemCode(optional):
string
A unique identifier for the document.
-
itemPrefix(optional):
string
Code Prefix.
-
itemSuffix(optional):
integer(int64)
The suffix of the unique identifier of an item.
-
link(optional):
string(url)
Read Only:
true
-
postedDate(optional):
object TimezoneSensitiveDateTime
-
projectCode(optional):
string
The user-specified identifier of a project.
-
projectId:
integer(int64)
The system-generated identifier of a project.
-
status(optional):
string
Allowed Values:
[ "DRAFT" ]
The status of a document. -
udfValues(optional):
array udfValues
Unique Items Required:
true
An object containing configured fields in the form of key-value pairs. -
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.
Nested Schema : codeValues
Type:
array
Unique Items Required:
true
The categories assigned to the custom log item.
Show Source
Nested Schema : udfValues
Type:
array
Unique Items Required:
true
An object containing configured fields in the form of key-value pairs.
Show Source
Nested Schema : ApiEntityCodeValueCustomLog
Type:
Show Source
object
-
codeType(optional):
object ApiEntityCodeType
-
codeValue:
object ApiEntityCodeValue
-
codeValueCustomLogId(optional):
integer(int64)
The system-generated identifier of a custom log.
-
customLogItemId(optional):
integer(int64)
The system-generated identifier of a document.
-
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.
Nested Schema : ApiEntityCodeType
Type:
Show Source
object
-
assignments(optional):
array assignments
Unique Items Required:
true
CodeType assignments. -
codeTypeCode:
string
Allowed Values:
[ "Length[1-40]" ]
This field displays the name of a code or value. -
codeTypeId(optional):
integer(int64)
The system-generated identifier of a code type.
-
codeTypeName:
string
Allowed Values:
[ "Length[1-40]" ]
The name of a code or value. -
link(optional):
string(url)
Read Only:
true
-
pushDownType:
string
Allowed Values:
[ "MANUAL", "AUTOMATIC" ]
The push down type of the workspace code. -
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. -
workspace:
integer(int64)
The ID of the owning workspace.
Nested Schema : ApiEntityCodeValue
Type:
Show Source
object
-
codeTypeId:
integer(int64)
The ID for the code type.
-
codeTypeName:
string
The name of a code or value.
-
codeValueCode:
string
Allowed Values:
[ "LENGTH[1-32]" ]
The unique identifier for the code value. -
codeValueId(optional):
integer(int64)
The unique identifier for the code value.
-
codeValueName:
string
Allowed Values:
[ "LENGTH[1-100]" ]
The name of the code value. -
link(optional):
string(url)
Read Only:
true
-
parentCodeValue(optional):
integer(int64)
The parent code value.
-
sequenceNumber:
integer(int32)
The number that specifies the position of the code value item within the code type list.
-
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 : assignments
Type:
array
Unique Items Required:
true
CodeType assignments.
Show Source
Nested Schema : ApiEntityCodeEntityType
Type:
Show Source
object
-
codeType:
object ApiEntityCodeType
-
entityType:
string
Allowed Values:
[ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]
Indicates the type of object the code is associated to. -
link(optional):
string(url)
Read Only:
true
-
primaryKey:
integer(int64)
The unique identifier of a code type table.
-
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 : ApiEntityCustomLogItemUdfValue
Type:
Show Source
object
-
columnDefinitionId(optional):
integer(int64)
The system-generated identifier of a field.
-
columnLabel(optional):
string
The user-specified UDF column label associated with a custom log.
-
columnName(optional):
string
Read Only:
true
The user-specified UDF column name associated with a custom log. -
customLogItemId(optional):
integer(int64)
The system-generated identifier of a document.
-
customLogItemUdfValId(optional):
integer(int64)
The system-generated identifier of a flex field value.
-
link(optional):
string(url)
Read Only:
true
-
udfValueDt(optional):
string(date-time)
A date value for a flex field.
-
udfValueNumber(optional):
object Number
-
udfValueText(optional):
string
A text value for a flex field.
-
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 : Number
Type:
object
404 Response
The requested custom log item does not exist, or you do not have access to it.