Jump to

• Request
• Response

Batch Update Custom Log Items

put

/api/restapi/customLogItem/batch

Send a request to this endpoint to update one or more custom log items. 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

Request Body - application/json ()

Root Schema : List<ApiEntityCustomLogItemInput>

Type: array

Title: List<ApiEntityCustomLogItemInput>

Show Source

• Array of: object ApiEntityCustomLogItemInput
  Title: ApiEntityCustomLogItemInput

  This entity represents a CustomLogItem object, a unique CustomLogItem object can be identified by the following combinations of the fields.

  • customLogItemId
  • customLogItemCode,customLogTypeObjectId
  • customLogItemCode,customLogTypeObjectName,projectId
  • customLogItemCode,customLogTypeObjectName,projectCode,workspaceCode
  • customLogItemCode,customLogTypeObjectName,programId
  • customLogItemCode,customLogTypeObjectName,programCode,workspaceCode

{
    "title":"List<ApiEntityCustomLogItemInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCustomLogItemInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested 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.

• customLogItemId
• customLogItemCode,customLogTypeObjectId
• customLogItemCode,customLogTypeObjectName,projectId
• customLogItemCode,customLogTypeObjectName,projectCode,workspaceCode
• customLogItemCode,customLogTypeObjectName,programId
• customLogItemCode,customLogTypeObjectName,programCode,workspaceCode

Show Source

• 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.
• 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.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityCustomLogItemInput",
    "required":[
        "customLogTypeObjectId",
        "customLogsItemName",
        "projectId"
    ],
    "type":"object",
    "properties":{
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified identifier of a project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "programCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ballInCourtUserName":{
            "maxLength":255,
            "type":"string",
            "description":"The user-specified identifier of the user associated with the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a custom log type.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogItemId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogTypeObjectId":{
            "type":"integer",
            "description":"The unique identifier for the custom log type object.The custom log type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogItemCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"A unique identifier unique of the custom log item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programId":{
            "type":"integer",
            "description":"A unique identifier of a Program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "comment":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Notes about the custom log item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "udfValues":{
            "type":"array",
            "description":"An object containing configured fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCustomLogItemConfiguredFieldValueInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "codeValues":{
            "type":"array",
            "description":"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.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueCustomLogInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of the custom log item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT"
            ]
        },
        "dueDate":{
            "type":"string",
            "description":"The date the custom log item is due.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ballInCourtId":{
            "type":"integer",
            "description":"The system-generated identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogsItemName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The name of the custom log item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CustomLogItem object, a unique CustomLogItem object can be identified by the following combinations of the fields.<ul><li>customLogItemId</li><li>customLogItemCode,customLogTypeObjectId</li><li>customLogItemCode,customLogTypeObjectName,projectId</li><li>customLogItemCode,customLogTypeObjectName,projectCode,workspaceCode</li><li>customLogItemCode,customLogTypeObjectName,programId</li><li>customLogItemCode,customLogTypeObjectName,programCode,workspaceCode</li>",
    "exampleSetFlag":false
}

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

{
    "type":"array",
    "description":"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.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueCustomLogInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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

{
    "type":"array",
    "description":"An object containing configured fields in the form of key-value pairs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCustomLogItemConfiguredFieldValueInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

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.

• 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

Show Source

• 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.
• 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.
• 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.

{
    "title":"ApiEntityCodeValueCustomLogInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "codeValueCustomLogId":{
            "type":"integer",
            "description":"The system-generated identifier of a custom log.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a document.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "codeValueCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeTypeCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueCustomLog object, a unique CodeValueCustomLog object can be identified by the following combinations of the fields.<ul><li>codeValueCustomLogId</li><li>codeValueId</li><li>codeTypeId,codeValueCode</li><li>codeTypeCode,codeValueCode</li><li>codeTypeCode,parentId,codeValueCode</li><li>codeValueCode,codeTypeId,parentId</li><li>codeTypeCode,codeValueCode,projectCode</li><li>codeTypeCode,codeValueCode,projectId</li><li>codeTypeCode,codeValueCode,parentId,projectCode</li><li>codeTypeCode,codeValueCode,parentId,projectId</li>",
    "exampleSetFlag":false
}

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.

• customLogItemConfiguredFieldValueId
• columnDefinitionId
• columnName
• columnLabel

Show Source

• 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.
• 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.
• 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.

{
    "title":"ApiEntityCustomLogItemConfiguredFieldValueInput",
    "type":"object",
    "properties":{
        "customLogConfiguredFieldValueId":{
            "type":"integer",
            "description":"The system-generated identifier of a flex field value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a document.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "numberValue":{
            "type":"number",
            "description":"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.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "columnName":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnLabel":{
            "maxLength":100,
            "minLength":1,
            "type":"string",
            "description":"The user-specified UDF column label.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "textValue":{
            "maxLength":4000,
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnDefinitionId":{
            "type":"integer",
            "description":"Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide value for this field during object update to delete the assigned configured field value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        }
    },
    "description":"This entity represents a CustomLogItemConfiguredFieldValue object, a unique CustomLogItemConfiguredFieldValue object can be identified by the following combinations of the fields.<ul><li>customLogItemConfiguredFieldValueId</li><li>columnDefinitionId</li><li>columnName</li><li>columnLabel</li>",
    "exampleSetFlag":false
}

Examples

Select an example Batch Update Custom Log Items by Assigning Hierarchical Code Values Using Codes Batch Update Custom Log Items Using Custom Log Item IDs Batch Update Custom Log Items by Assigning Code Values Using Codes or IDs

Back to Top

Response

200 Response

A collection of object IDs mapped to a canonical link of the object with corresponding warning messages if any warnings were generated while processing the update request. For example - {"links":{"1":"https://[host]:[port]/api/restapi/[object]/1","2":"https://[host]:[port]/api/restapi/[object]/2"},"warnings":[{"primaryKeyName":"objectIdFieldName","uniqueFieldName":"object_code_01","uniqueFieldValue":"objectCodeFieldName","primaryKeyValue":1,"warningMessages":["warning_message_1","warning_message_2"]}]}

400 Response

Invalid Input.

Back to Top