Jump to

• Request
• Response

View Custom Log Type Objects by Workspace

get

/api/restapi/customLogTypeObject/workspace/{workspaceId}

Send a request to this end point to view all the custom log type objects created and assigned to the workspace specified as a path parameter

Request

Path Parameters

• workspaceId(required): integer(int64)
  The system-generated 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<ApiEntityCustomLogTypeObject>

Type: array

Title: List<ApiEntityCustomLogTypeObject>

Show Source

• Array of: object ApiEntityCustomLogTypeObject
  Title: ApiEntityCustomLogTypeObject

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

Nested Schema : ApiEntityCustomLogTypeObject

Type: object

Title: ApiEntityCustomLogTypeObject

Show Source

• appliesTo: array appliesTo
  The list of code type assignments.
• assignedWorkspaceCode: string
  Maximum Length: 60

  The user defined identifier of the workspace for which the custom log type belongs.
• assignedWorkspaceId: integer (int64)
  The system generated identifier of the workspace for which the custom log type belongs.
• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  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: 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)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• ownershipType: string
  Allowed Values: [ "WORKSPACE", "PROJECT", "PROGRAM" ]

  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: 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: integer (int64)
  The system-generated identifier of a reference to another object.
• securityGuid: string
  Maximum Length: 32

  The globally unique identifier of an object.
• sequenceNumber: integer (int32)
  The sequence number of an object.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Maximum Length: 60

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

{
    "title":"ApiEntityCustomLogTypeObject",
    "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"
            ]
        },
        "scopeId":{
            "type":"integer",
            "description":"The system-generated identifier of a reference to another object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sequenceNumber":{
            "type":"integer",
            "description":"The sequence number of an object.",
            "format":"int32",
            "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/ApiEntityCustomLogUdf",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "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":"The type of association between a document and an object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "assignedWorkspaceId":{
            "type":"integer",
            "description":"The system generated identifier of the workspace for which the custom log type belongs.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "assignedWorkspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user defined identifier of the workspace for which the custom log type belongs.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "securityGuid":{
            "maxLength":"32",
            "type":"string",
            "description":"The globally unique identifier of an object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ownershipType":{
            "type":"string",
            "description":"The ownership type of the custom log type object.",
            "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/ApiEntityCustomLogTypeCodeType",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "appliesTo":{
            "type":"array",
            "description":"The list of code type assignments.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCustomLogEntityType",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : appliesTo

Type: array

The list of code type assignments.

Show Source

• Array of: object ApiEntityCustomLogEntityType
  Title: ApiEntityCustomLogEntityType

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

Nested Schema : customLogTypeCodeTypes

Type: array

The code types associated with a custom log type object.

Show Source

• Array of: object ApiEntityCustomLogTypeCodeType
  Title: ApiEntityCustomLogTypeCodeType

{
    "type":"array",
    "description":"The code types associated with a custom log type object.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCustomLogTypeCodeType",
        "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 ApiEntityCustomLogUdf
  Title: ApiEntityCustomLogUdf

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

Nested Schema : ApiEntityCustomLogEntityType

Type: object

Title: ApiEntityCustomLogEntityType

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

  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

  Date when the record was last updated.

{
    "title":"ApiEntityCustomLogEntityType",
    "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",
            "readOnly":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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCustomLogTypeCodeType

Type: object

Title: ApiEntityCustomLogTypeCodeType

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)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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":"ApiEntityCustomLogTypeCodeType",
    "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"
            ]
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityCustomLogUdf

Type: object

Title: ApiEntityCustomLogUdf

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)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityCustomLogUdf",
    "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"
            ]
        },
        "columnName":{
            "maxLength":"100",
            "minLength":"1",
            "type":"string",
            "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"
            ]
        },
        "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.

404 Response

The given workspace ID doesn't exist or has been deleted.

Back to Top