Update a Custom Log Item
put
/api/restapi/customLogItem
Send a request to this endpoint to update a custom log item. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : ApiEntityCustomLogItemInput
Type:
object
Title:
ApiEntityCustomLogItemInput
This entity represents a CustomLogItem object, a unique CustomLogItem object can be identified by the following combinations of the fields.
Show Source
- customLogItemId
- customLogItemCode,customLogTypeObjectId
- customLogItemCode,customLogTypeObjectName,projectId
- customLogItemCode,customLogTypeObjectName,projectCode,workspaceCode
- customLogItemCode,customLogTypeObjectName,programId
- customLogItemCode,customLogTypeObjectName,programCode,workspaceCode
-
ballInCourtId: integer
(int64)
The system-generated identifier of a user.
-
ballInCourtUserName: string
Maximum Length:
255
The user-specified identifier of the user associated with the object. -
codeValues: array
codeValues
The list of code values for a custom log item. This entity can only be used to assign codeValues or create codeValues on the fly.
-
comment: string
Minimum Length:
0
Maximum Length:4000
Notes about the custom log item. -
customLogItemCode: string
Minimum Length:
1
Maximum Length:60
A unique identifier unique of the custom log item. -
customLogItemId: integer
(int64)
The system-generated identifier of a custom log item. This value should not be provided in create operation request data, however, it is required for update requests.
-
customLogsItemName(required): string
Minimum Length:
0
Maximum Length:255
The name of the custom log item. -
customLogTypeObjectId(required): integer
(int64)
The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.
-
customLogTypeObjectName: string
Minimum Length:
0
Maximum Length:255
The user-specified identifier of a custom log type. -
dueDate: string
(date-time)
The date the custom log item is due.
-
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. -
postedDate: string(date-time)Read Only:true
Deprecated. As of 23.12.The date the custom log item was added. -
programCode: string
Maximum Length:
60
The unique identifier for a program set by the user who created the program. -
programId: integer
(int64)
A unique identifier of a Program.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The user-specified identifier of a project. -
projectId(required): integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
status: string
Allowed Values:
[ "DRAFT" ]
The status of the custom log item. -
udfValues: array
udfValues
An object containing configured fields in the form of key-value pairs.
-
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 : codeValues
Type:
array
The list of code values for a custom log item. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
-
Array of:
object ApiEntityCodeValueCustomLogInput
Title:
ApiEntityCodeValueCustomLogInput
This entity represents a CodeValueCustomLog object, a unique CodeValueCustomLog object can be identified by the following combinations of the fields.- codeValueCustomLogId
- codeValueId
- codeTypeId,codeValueCode
- codeTypeCode,codeValueCode
- codeTypeCode,parentId,codeValueCode
- codeValueCode,codeTypeId,parentId
- codeTypeCode,codeValueCode,projectCode
- codeTypeCode,codeValueCode,projectId
- codeTypeCode,codeValueCode,parentId,projectCode
- codeTypeCode,codeValueCode,parentId,projectId
Nested Schema : udfValues
Type:
array
An object containing configured fields in the form of key-value pairs.
Show Source
-
Array of:
object ApiEntityCustomLogItemConfiguredFieldValueInput
Title:
ApiEntityCustomLogItemConfiguredFieldValueInput
This entity represents a CustomLogItemConfiguredFieldValue object, a unique CustomLogItemConfiguredFieldValue object can be identified by the following combinations of the fields.- customLogItemConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
Nested Schema : ApiEntityCodeValueCustomLogInput
Type:
object
Title:
ApiEntityCodeValueCustomLogInput
This entity represents a CodeValueCustomLog object, a unique CodeValueCustomLog object can be identified by the following combinations of the fields.
Show Source
- codeValueCustomLogId
- codeValueId
- codeTypeId,codeValueCode
- codeTypeCode,codeValueCode
- codeTypeCode,parentId,codeValueCode
- codeValueCode,codeTypeId,parentId
- codeTypeCode,codeValueCode,projectCode
- codeTypeCode,codeValueCode,projectId
- codeTypeCode,codeValueCode,parentId,projectCode
- codeTypeCode,codeValueCode,parentId,projectId
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete code value assigned to the object. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeTypeName: stringMinimum Length:0
Maximum Length:255
Deprecated. As of 23.11.The name of a code or value. -
codeValueCode(required): string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
codeValueCustomLogId: integer
(int64)
The system-generated identifier of a custom log.
-
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1
Maximum Length:255
The name of the code value. -
customLogItemId: integer
(int64)
The system-generated identifier of a document.
-
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. -
parentId: integer
(int64)
The unique identifier of a parent code value.
-
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.
-
sequenceNumber: integer(int32)Deprecated. As of 23.11.The number that specifies the position of the code value item within the code type list. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Nested Schema : ApiEntityCustomLogItemConfiguredFieldValueInput
Type:
object
Title:
ApiEntityCustomLogItemConfiguredFieldValueInput
This entity represents a CustomLogItemConfiguredFieldValue object, a unique CustomLogItemConfiguredFieldValue object can be identified by the following combinations of the fields.
Show Source
- customLogItemConfiguredFieldValueId
- columnDefinitionId
- columnName
- columnLabel
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: numberRead Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record. -
costValueWorkspace1: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace1 currency conversion. -
costValueWorkspace2: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace2 currency conversion. -
costValueWorkspace3: number(double)Read Only:true
Deprecated. As of 23.10.This holds values for Cost type configured fields in the workspace3 currency conversion. -
customLogConfiguredFieldValueId: integer
(int64)
The system-generated identifier of a flex field value.
-
customLogItemId: integer
(int64)
The system-generated identifier of a document.
-
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
exceptionMessage: stringRead Only:true
Maximum Length:4000
Deprecated. As of 23.10.Provides the error message for why the formula calculation resulted in an error. -
hasException: booleanRead Only:true
Deprecated. As of 23.10.Determines if formula calculation hit an error calculating a value for this field. -
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. -
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
textValue: string
Maximum Length:
4000
This holds values for Boolean, List and Text type configured fields. -
updateDate: string(date-time)Read Only:true
Deprecated. As of 23.10.Date when the record was last updated.
Examples
Back to Top
Response
204 Response
Successful operation with no content.
400 Response
Invalid Input.