Jump to

• Request
• Response

View a Custom Log Item by Parent

get

/api/restapi/customLogItem/workspace/{workspaceCode}/project/{projectCode}/customLogObject/{customLogTypeObjectName}

This endpoint returns custom log items that meet the following requirements:

• The object is associated with a project with a code value that matches the value of the {projectCode} path parameter.
• The object is associated with a workspace with a code value that matches the value of the {workspaceCode} path parameter.
• The object is associated with a custom log type object with a name that matches the value of the {customLogTypeObjectName} path parameter.

Request

Path Parameters

• customLogTypeObjectName(required): string
  The name of a custom log type object.
• projectCode(required): string
  The user-specified identifier of a project.
• workspaceCode(required): string
  The user-specified identifier of a workspace.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : List<ApiEntityCustomLogItem>

Type: array

Title: List<ApiEntityCustomLogItem>

Show Source

• Array of: object ApiEntityCustomLogItem
  Title: ApiEntityCustomLogItem

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

Nested Schema : ApiEntityCustomLogItem

Type: object

Title: ApiEntityCustomLogItem

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

  Maximum Length: 255

  The name of the custom log item.
• customLogTypeObjectId: 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)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• postedDate: string (date-time)
  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: 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)
  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.

{
    "title":"ApiEntityCustomLogItem",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "customLogTypeObjectName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a custom log type.",
            "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"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "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"
            ]
        },
        "customLogItemCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"A unique identifier unique of the custom log item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "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"
            ]
        },
        "status":{
            "type":"string",
            "description":"The status of the custom log item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DRAFT"
            ]
        },
        "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/ApiEntityCodeValueCustomLog",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "udfValues":{
            "type":"array",
            "description":"An object containing configured fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCustomLogItemConfiguredFieldValue",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "postedDate":{
            "type":"string",
            "description":"The date the custom log item was added.",
            "format":"date-time",
            "exampleSetFlag":false
        },
        "dueDate":{
            "type":"string",
            "description":"The date the custom log item is due.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogsItemName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of the custom log item.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ballInCourtId":{
            "type":"integer",
            "description":"The system-generated identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "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 ApiEntityCodeValueCustomLog
  Title: ApiEntityCodeValueCustomLog

{
    "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/ApiEntityCodeValueCustomLog",
        "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 ApiEntityCustomLogItemConfiguredFieldValue
  Title: ApiEntityCustomLogItemConfiguredFieldValue

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

Nested Schema : ApiEntityCodeValueCustomLog

Type: object

Title: ApiEntityCodeValueCustomLog

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

  Maximum Length: 255

  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)
  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)
  The number that specifies the position of the code value item within the code type list.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCodeValueCustomLog",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a document.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCustomLogId":{
            "type":"integer",
            "description":"The system-generated identifier of a custom log.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The number that specifies the position of the code value item within the code type list.",
            "format":"int32",
            "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"
            ]
        },
        "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"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeTypeName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueName":{
            "maxLength":"255",
            "minLength":"1",
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCustomLogItemConfiguredFieldValue

Type: object

Title: ApiEntityCustomLogItemConfiguredFieldValue

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.
• costValue: number
  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)
  This holds values for Cost type configured fields in the workspace1 currency conversion.
• costValueWorkspace2: number (double)
  This holds values for Cost type configured fields in the workspace2 currency conversion.
• costValueWorkspace3: number (double)
  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: string
  Maximum Length: 4000

  Provides the error message for why the formula calculation resulted in an error.
• hasException: boolean
  Determines if formula calculation hit an error calculating a value for this field.
• link: string (url)
  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)
  Date when the record was last updated.

{
    "title":"ApiEntityCustomLogItemConfiguredFieldValue",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogItemId":{
            "type":"integer",
            "description":"The system-generated identifier of a document.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogConfiguredFieldValueId":{
            "type":"integer",
            "description":"The system-generated identifier of a flex field value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified UDF column label.",
            "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"
            ]
        },
        "textValue":{
            "maxLength":"4000",
            "type":"string",
            "description":"This holds values for Boolean, List and Text type configured fields.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "dateValue":{
            "type":"string",
            "description":"This holds values for Date type configured fields.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValue":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "hasException":{
            "type":"boolean",
            "description":"Determines if formula calculation hit an error calculating a value for this field.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "exceptionMessage":{
            "maxLength":"4000",
            "type":"string",
            "description":"Provides the error message for why the formula calculation resulted in an error.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costValueWorkspace1":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace1 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace2":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace2 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "costValueWorkspace3":{
            "type":"number",
            "description":"This holds values for Cost type configured fields in the workspace3 currency conversion.",
            "format":"double",
            "exampleSetFlag":false
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

Back to Top