Jump to

• Request
• Response

Update a Custom Log Type Object

put

/api/restapi/customLogTypeObject

Send a request to this endpoint to update a custom log type object. 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

Request Body - application/json ()

Root Schema : ApiEntityCustomLogTypeObjectInput

Type: object

Title: ApiEntityCustomLogTypeObjectInput

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

• customLogTypeObjectId
• customLogTypeObjectName,scope,scopeId
• customLogTypeObjectName,scope,scopeCode,workspaceId
• customLogTypeObjectName,scope,scopeCode,workspaceCode

Show Source

• appliesTo: array appliesTo
  The list of code type assignments.
• assignedWorkspaceCode: string
  Read Only: true

  Maximum Length: 60

  Deprecated. As of 23.12.
  The user defined identifier of the workspace for which the custom log type belongs.
• assignedWorkspaceId: integer (int64)
  Read Only: true

  Deprecated. As of 23.12.
  The system generated identifier of the workspace for which the custom log type belongs.
• associationType: string
  Read Only: true

  Allowed Values: [ "OWNED", "INHERITED" ]

  Deprecated. As of 23.12.
  The type of association between a document and an object.
• customLogTypeCodeTypes: array customLogTypeCodeTypes
  The code types associated with a custom log type object.
• customLogTypeObjectId: integer (int64)
  The system-generated identifier of custom log type object.
• customLogTypeObjectName(required): string
  Minimum Length: 0

  Maximum Length: 255

  The user-defined identifier of a custom log type object.
• customLogUdfs: array customLogUdfs
  An object containing configured fields in the form of key-value pairs.
• 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.
• ownershipType: string
  Read Only: true

  Allowed Values: [ "WORKSPACE", "PROJECT", "PROGRAM" ]

  Deprecated. As of 23.12.
  The ownership type of the custom log type object.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  How data is shared between parent and child workspaces.
  Manual: Data can be pulled down by child workspaces. This is the default option.
  Automatic: Data is automatically shared with all child workspaces.
• scope(required): string
  Maximum Length: 40

  Allowed Values: [ "project", "program", "workspace" ]

  The scope of an object.
• scopeCode: string
  Maximum Length: 60

  The user-defined identifier of a reference to another object.
• scopeId(required): integer (int64)
  The system-generated identifier of a reference to another object.
• securityGuid: string
  Read Only: true

  Maximum Length: 32

  Deprecated. As of 23.12.
  The globally unique identifier of an object.
• sequenceNumber: integer (int32)
  Read Only: true

  Deprecated. As of 23.12.
  The sequence number of an object.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.12.
  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityCustomLogTypeObjectInput",
    "required":[
        "customLogTypeObjectName",
        "scope",
        "scopeId",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "scopeId":{
            "type":"integer",
            "description":"The system-generated identifier of a reference to another object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The sequence number of an object.",
            "format":"int32",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "maxLength":"40",
            "type":"string",
            "description":"The scope of an object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "project",
                "program",
                "workspace"
            ]
        },
        "customLogUdfs":{
            "type":"array",
            "description":"An object containing configured fields in the form of key-value pairs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCustomLogUdfInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"How data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The type of association between a document and an object.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "assignedWorkspaceId":{
            "type":"integer",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The system generated identifier of the workspace for which the custom log type belongs.",
            "format":"int64",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignedWorkspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The user defined identifier of the workspace for which the custom log type belongs.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "securityGuid":{
            "maxLength":"32",
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The globally unique identifier of an object.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ownershipType":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.12</i>.</br>The ownership type of the custom log type object.",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "WORKSPACE",
                "PROJECT",
                "PROGRAM"
            ]
        },
        "scopeCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-defined identifier of a reference to another object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectName":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string",
            "description":"The user-defined identifier of a custom log type object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectId":{
            "type":"integer",
            "description":"The system-generated identifier of custom log type object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogTypeCodeTypes":{
            "type":"array",
            "description":"The code types associated with a custom log type object.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCustomLogTypeCodeTypeInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "appliesTo":{
            "type":"array",
            "description":"The list of code type assignments.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCustomLogEntityTypeInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "description":"This entity represents a CustomLogTypeObject object, a unique CustomLogTypeObject object can be identified by the following combinations of the fields.<ul><li>customLogTypeObjectId</li><li>customLogTypeObjectName,scope,scopeId</li><li>customLogTypeObjectName,scope,scopeCode,workspaceId</li><li>customLogTypeObjectName,scope,scopeCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : appliesTo

Type: array

The list of code type assignments.

Show Source

• Array of: object ApiEntityCustomLogEntityTypeInput
  Title: ApiEntityCustomLogEntityTypeInput

{
    "type":"array",
    "description":"The list of code type assignments.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCustomLogEntityTypeInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : customLogTypeCodeTypes

Type: array

The code types associated with a custom log type object.

Show Source

• Array of: object ApiEntityCustomLogTypeCodeTypeInput
  Title: ApiEntityCustomLogTypeCodeTypeInput

{
    "type":"array",
    "description":"The code types associated with a custom log type object.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCustomLogTypeCodeTypeInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : customLogUdfs

Type: array

An object containing configured fields in the form of key-value pairs.

Show Source

• Array of: object ApiEntityCustomLogUdfInput
  Title: ApiEntityCustomLogUdfInput

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

Nested Schema : ApiEntityCustomLogEntityTypeInput

Type: object

Title: ApiEntityCustomLogEntityTypeInput

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• customLogEntityTypeId: integer (int64)
  The system-generated identifier of custom log type object and entity association.
• entityType: string
  Allowed Values: [ "PROGRAM", "PROJECT" ]

  Indicates the type of object the custom log type object is associated to.
• 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.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityCustomLogEntityTypeInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "entityType":{
            "type":"string",
            "description":"Indicates the type of object the custom log type object is associated to.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PROGRAM",
                "PROJECT"
            ]
        },
        "customLogEntityTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of custom log type object and entity association.",
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCustomLogTypeCodeTypeInput

Type: object

Title: ApiEntityCustomLogTypeCodeTypeInput

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• codeTypeCode: string
  Minimum Length: 0

  Maximum Length: 60
• codeTypeId: integer (int64)
  The system-generated identifier of a code type.
• customLogTypeCodeTypeId: integer (int64)
  The system-generated identifier of a doc type.
• customLogTypeObjectId: integer (int64)
  The system-generated identifier of a custom log type object.
• 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.
• 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.

{
    "title":"ApiEntityCustomLogTypeCodeTypeInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a code type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeCodeTypeId":{
            "type":"integer",
            "description":"The system-generated identifier of a doc type.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogTypeObjectId":{
            "type":"integer",
            "description":"The system-generated identifier of a custom log type object.",
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCustomLogUdfInput

Type: object

Title: ApiEntityCustomLogUdfInput

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide value for this field during object update to delete the assigned configured field value.
• columnLabel: string
  Minimum Length: 1

  Maximum Length: 100
• columnName: string
  Minimum Length: 1

  Maximum Length: 100
• customLogObjectId: integer (int64)
  The system-generated identifier of custom log type object.
• customLogUdfId: integer (int64)
  The system-generated identifier of a code type.
• fdColumnId: integer (int64)
  The system-generated identifier of a column.
• 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.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.

{
    "title":"ApiEntityCustomLogUdfInput",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "fdColumnId":{
            "type":"integer",
            "description":"The system-generated identifier of a column.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "customLogObjectId":{
            "type":"integer",
            "description":"The system-generated identifier of custom log type object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "columnLabel":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogUdfId":{
            "type":"integer",
            "description":"The system-generated identifier of a code type.",
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Update a Custom Log Type Object Using Custom Log Type Object ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid Input.

Back to Top