Jump to

• Request
• Response

Batch Assign Custom Log Type Objects to a Workspaces, Programs and Projects

post

/api/restapi/customLogTypeObject/assign/batch

Send a request to this end point to assign custom log type objects to the other workspaces in their workspace hierarchy, projects and programs under the created workspace.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityCustomLogTypeObjectAssignRequestInput>

Type: array

Title: List<ApiEntityCustomLogTypeObjectAssignRequestInput>

Show Source

• Array of: object ApiEntityCustomLogTypeObjectAssignRequestInput
  Title: ApiEntityCustomLogTypeObjectAssignRequestInput

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

Nested Schema : ApiEntityCustomLogTypeObjectAssignRequestInput

Type: object

Title: ApiEntityCustomLogTypeObjectAssignRequestInput

Show Source

• customLogTypeObject(required): customLogTypeObject
  This field represents the custom log type object record that needs to assigned to a different workspaces, programs and projects. It contains the fields to uniquely identify a custom log type object record.
• programs: array programs
  This field represents the list of program records that the custom log type object needs to be assigned.
• projects: array projects
  This field represents the list of project records that the custom log type object needs to be assigned.
• workspaces: array workspaces
  This field represents the list of workspace records that the custom log type object needs to be assigned.

{
    "title":"ApiEntityCustomLogTypeObjectAssignRequestInput",
    "required":[
        "customLogTypeObject"
    ],
    "type":"object",
    "properties":{
        "workspaces":{
            "type":"array",
            "description":"This field represents the list of workspace records that the custom log type object needs to be assigned.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/WorkspaceIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "customLogTypeObject":{
            "description":"This field represents the custom log type object record that needs to assigned to a different workspaces, programs and projects. It contains the fields to uniquely identify a custom log type object record.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier"
                }
            ]
        },
        "programs":{
            "type":"array",
            "description":"This field represents the list of program records that the custom log type object needs to be assigned.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ProgramIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projects":{
            "type":"array",
            "description":"This field represents the list of project records that the custom log type object needs to be assigned.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ProjectIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : customLogTypeObject

This field represents the custom log type object record that needs to assigned to a different workspaces, programs and projects. It contains the fields to uniquely identify a custom log type object record.

Match All

Show Source

• object CustomLogTypeObjectIdentifier
  Title: CustomLogTypeObjectIdentifier

{
    "description":"This field represents the custom log type object record that needs to assigned to a different workspaces, programs and projects. It contains the fields to uniquely identify a custom log type object record.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier"
        }
    ]
}

Nested Schema : programs

Type: array

This field represents the list of program records that the custom log type object needs to be assigned.

Show Source

• Array of: object ProgramIdentifier
  Title: ProgramIdentifier

{
    "type":"array",
    "description":"This field represents the list of program records that the custom log type object needs to be assigned.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ProgramIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : projects

Type: array

This field represents the list of project records that the custom log type object needs to be assigned.

Show Source

• Array of: object ProjectIdentifier
  Title: ProjectIdentifier

{
    "type":"array",
    "description":"This field represents the list of project records that the custom log type object needs to be assigned.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ProjectIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : workspaces

Type: array

This field represents the list of workspace records that the custom log type object needs to be assigned.

Show Source

• Array of: object WorkspaceIdentifier
  Title: WorkspaceIdentifier

{
    "type":"array",
    "description":"This field represents the list of workspace records that the custom log type object needs to be assigned.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/WorkspaceIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : CustomLogTypeObjectIdentifier

Type: object

Title: CustomLogTypeObjectIdentifier

Show Source

• customLogTypeObjectId: integer (int64)
  The system-generated identifier of custom log type object.
• customLogTypeObjectName: string
  The user-defined identifier of a custom log type object.
• scope: string
  Maximum Length: 40

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

  The scope of an object.
• scopeCode: string
  The user-defined identifier of a reference to another object.
• scopeId: integer (int64)
  The system-generated identifier of a reference to another object.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CustomLogTypeObjectIdentifier",
    "type":"object",
    "properties":{
        "scopeId":{
            "type":"integer",
            "description":"The system-generated identifier of a reference to another object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "maxLength":"40",
            "type":"string",
            "description":"The scope of an object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "project",
                "program",
                "workspace"
            ]
        },
        "scopeCode":{
            "type":"string",
            "description":"The user-defined identifier of a reference to another object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectName":{
            "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"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProgramIdentifier

Type: object

Title: ProgramIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramIdentifier",
    "type":"object",
    "properties":{
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ProjectIdentifier

Type: object

Title: ProjectIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProjectIdentifier",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : WorkspaceIdentifier

Type: object

Title: WorkspaceIdentifier

Show Source

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

{
    "title":"WorkspaceIdentifier",
    "type":"object",
    "properties":{
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

The object was successfully updated.

Body ()

Root Schema : ApiEntityCustomLogTypeObjectAssignResponse

Type: object

Title: ApiEntityCustomLogTypeObjectAssignResponse

Show Source

• customLogTypeObject: customLogTypeObject
  Read Only: true

  This field represents the custom log type object record that needs to assigned to a different workspaces, programs and projects. It contains the fields to uniquely identify a custom log type object record.
• errorMessage: string
  Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.
• programs: array programs
  This field represents the list of program records along with the status of the assign operation.
• projects: array projects
  This field represents the list of project records along with the status of the assign operation.
• statusCode: integer (int64)
  The status code of the operation on a given object.
• warning: string
  Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.
• workspaces: array workspaces
  This field represents the list of workspace records along with the status of the assign operation.

{
    "title":"ApiEntityCustomLogTypeObjectAssignResponse",
    "type":"object",
    "properties":{
        "warning":{
            "type":"string",
            "description":"Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "errorMessage":{
            "type":"string",
            "description":"Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaces":{
            "type":"array",
            "description":"This field represents the list of workspace records along with the status of the assign operation.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityGenericResponseWorkspaceIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "customLogTypeObject":{
            "description":"This field represents the custom log type object record that needs to assigned to a different workspaces, programs and projects. It contains the fields to uniquely identify a custom log type object record.",
            "readOnly":true,
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier"
                }
            ]
        },
        "programs":{
            "type":"array",
            "description":"This field represents the list of program records along with the status of the assign operation.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityGenericResponseProgramIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "projects":{
            "type":"array",
            "description":"This field represents the list of project records along with the status of the assign operation.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityGenericResponseProjectIdentifier",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The status code of the operation on a given object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : customLogTypeObject

Read Only: true

This field represents the custom log type object record that needs to assigned to a different workspaces, programs and projects. It contains the fields to uniquely identify a custom log type object record.

Match All

Show Source

• object CustomLogTypeObjectIdentifier
  Title: CustomLogTypeObjectIdentifier

{
    "description":"This field represents the custom log type object record that needs to assigned to a different workspaces, programs and projects. It contains the fields to uniquely identify a custom log type object record.",
    "readOnly":true,
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/CustomLogTypeObjectIdentifier"
        }
    ]
}

Nested Schema : programs

Type: array

This field represents the list of program records along with the status of the assign operation.

Show Source

• Array of: object ApiEntityGenericResponseProgramIdentifier
  Title: ApiEntityGenericResponseProgramIdentifier

{
    "type":"array",
    "description":"This field represents the list of program records along with the status of the assign operation.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityGenericResponseProgramIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : projects

Type: array

This field represents the list of project records along with the status of the assign operation.

Show Source

• Array of: object ApiEntityGenericResponseProjectIdentifier
  Title: ApiEntityGenericResponseProjectIdentifier

{
    "type":"array",
    "description":"This field represents the list of project records along with the status of the assign operation.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityGenericResponseProjectIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : workspaces

Type: array

This field represents the list of workspace records along with the status of the assign operation.

Show Source

• Array of: object ApiEntityGenericResponseWorkspaceIdentifier
  Title: ApiEntityGenericResponseWorkspaceIdentifier

{
    "type":"array",
    "description":"This field represents the list of workspace records along with the status of the assign operation.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityGenericResponseWorkspaceIdentifier",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : CustomLogTypeObjectIdentifier

Type: object

Title: CustomLogTypeObjectIdentifier

Show Source

• customLogTypeObjectId: integer (int64)
  The system-generated identifier of custom log type object.
• customLogTypeObjectName: string
  The user-defined identifier of a custom log type object.
• scope: string
  Maximum Length: 40

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

  The scope of an object.
• scopeCode: string
  The user-defined identifier of a reference to another object.
• scopeId: integer (int64)
  The system-generated identifier of a reference to another object.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CustomLogTypeObjectIdentifier",
    "type":"object",
    "properties":{
        "scopeId":{
            "type":"integer",
            "description":"The system-generated identifier of a reference to another object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "scope":{
            "maxLength":"40",
            "type":"string",
            "description":"The scope of an object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "project",
                "program",
                "workspace"
            ]
        },
        "scopeCode":{
            "type":"string",
            "description":"The user-defined identifier of a reference to another object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "customLogTypeObjectName":{
            "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"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityGenericResponseProgramIdentifier

Type: object

Title: ApiEntityGenericResponseProgramIdentifier

Show Source

• errorMessage: string
  Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.
• object: object
  The object the operation performed on.
• statusCode: integer (int64)
  The status code of the operation on a given object.
• warning: string
  Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.

{
    "title":"ApiEntityGenericResponseProgramIdentifier",
    "type":"object",
    "properties":{
        "object":{
            "description":"The object the operation performed on.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ProgramIdentifier"
                }
            ]
        },
        "errorMessage":{
            "type":"string",
            "description":"Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "warning":{
            "type":"string",
            "description":"Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The status code of the operation on a given object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : object

The object the operation performed on.

Match All

Show Source

• object ProgramIdentifier
  Title: ProgramIdentifier

{
    "description":"The object the operation performed on.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ProgramIdentifier"
        }
    ]
}

Nested Schema : ProgramIdentifier

Type: object

Title: ProgramIdentifier

Show Source

• programCode: string
  Maximum Length: 60

  The unique identifier for a program set by the user who created the program.
• programId: integer (int64)
  The unique identifier for the program.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProgramIdentifier",
    "type":"object",
    "properties":{
        "programId":{
            "type":"integer",
            "description":"The unique identifier for the program.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "programCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a program set by the user who created the program.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityGenericResponseProjectIdentifier

Type: object

Title: ApiEntityGenericResponseProjectIdentifier

Show Source

• errorMessage: string
  Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.
• object: object
  The object the operation performed on.
• statusCode: integer (int64)
  The status code of the operation on a given object.
• warning: string
  Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.

{
    "title":"ApiEntityGenericResponseProjectIdentifier",
    "type":"object",
    "properties":{
        "object":{
            "description":"The object the operation performed on.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ProjectIdentifier"
                }
            ]
        },
        "errorMessage":{
            "type":"string",
            "description":"Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "warning":{
            "type":"string",
            "description":"Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The status code of the operation on a given object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : object

The object the operation performed on.

Match All

Show Source

• object ProjectIdentifier
  Title: ProjectIdentifier

{
    "description":"The object the operation performed on.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ProjectIdentifier"
        }
    ]
}

Nested Schema : ProjectIdentifier

Type: object

Title: ProjectIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProjectIdentifier",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityGenericResponseWorkspaceIdentifier

Type: object

Title: ApiEntityGenericResponseWorkspaceIdentifier

Show Source

• errorMessage: string
  Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.
• object: object
  The object the operation performed on.
• statusCode: integer (int64)
  The status code of the operation on a given object.
• warning: string
  Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.

{
    "title":"ApiEntityGenericResponseWorkspaceIdentifier",
    "type":"object",
    "properties":{
        "object":{
            "description":"The object the operation performed on.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/WorkspaceIdentifier"
                }
            ]
        },
        "errorMessage":{
            "type":"string",
            "description":"Represents the error message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "warning":{
            "type":"string",
            "description":"Represents the warning message for the operation on a given object. The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The status code of the operation on a given object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : object

The object the operation performed on.

Match All

Show Source

• object WorkspaceIdentifier
  Title: WorkspaceIdentifier

{
    "description":"The object the operation performed on.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/WorkspaceIdentifier"
        }
    ]
}

Nested Schema : WorkspaceIdentifier

Type: object

Title: WorkspaceIdentifier

Show Source

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

{
    "title":"WorkspaceIdentifier",
    "type":"object",
    "properties":{
        "workspaceCode":{
            "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"
            ]
        }
    },
    "exampleSetFlag":false
}

Back to Top