ResponseWorkspaceDto

Example Json Object

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "errorMessage": "string",
12        "field": "string",
13        "errorKey": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 0,
19    "displayId": "string",
20    "name": "string",
21    "state": "INV_DRAFT",
22    "postingDate": "2019-08-24",
23    "userDocumentDate": "2019-08-24",
24    "owner": {
25      "id": 0,
26      "accountId": 0,
27      "fullName": "string",
28      "firstName": "string",
29      "lastName": "string",
30      "username": "string",
31      "email": "string",
32      "accountName": "string",
33      "profile": "string"
34    },
35    "allowsSystemGenerateNewId": true,
36    "numberRangeIdentifierValue": "string",
37    "numberRangeIdentifierType": {
38      "name": "string"
39    },
40    "numberRangeType": {
41      "name": "string"
42    }
43  }
44}

📄 Description: Data transfer object representing a workspace response, encapsulating key details and metadata related to workspace configurations and user interactions, facilitating effective collaboration and resource management.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the informational message related to the response, providing context or details pertinent to the user’s request.

defaultMessage

string

false

write-only

Default message to be displayed in the workspace, providing users with essential information or guidance.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the request, aiding in troubleshooting and resolution.

errors

Errors

false

none

Contains a list of error messages encountered during the processing of the workspace response, providing insights for troubleshooting and resolution.

object

WorkspaceDto

false

none

Represents the primary data structure containing detailed information about the workspace, facilitating effective management and organization within the application.

Enumerated Values

Attribute

Value

code

API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED