Entity Tab Resource¶
Get All Tabs¶
HTTP Request
GET /api/entityTab
📋 Description: Fetches a list of entity tabs, providing users with access to relevant data and insights for effective decision-making.
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "entityName": "string",
8 "label": "string",
9 "mandatory": true,
10 "visible": true,
11 "sections": [
12 {
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "name": "string",
17 "label": "string",
18 "mandatory": true,
19 "visible": true,
20 "parentTab": "string"
21 }
22 ]
23 }
24]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an entity tab configuration, encapsulating essential attributes and settings for effective data management within the application.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» name |
string |
false |
none |
Name of the resource |
» entityName |
string |
false |
none |
Name of the entity |
» label |
string |
false |
none |
Label for the resource |
» mandatory |
boolean |
false |
none |
Indicates whether the associated entity tab is required for completion within the system. |
» visible |
boolean |
false |
none |
Whether this resource is visible |
» sections |
false |
none |
An array of EntityTabDTO objects representing the various sections associated with the entity, facilitating organized data management and retrieval. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» name |
string |
false |
none |
Name of the resource |
»» label |
string |
false |
none |
Label for the resource |
»» mandatory |
boolean |
false |
none |
Indicates whether the tab section is required for completion in the user interface. |
»» visible |
boolean |
false |
none |
Whether this resource is visible |
»» parentTab |
string |
false |
none |
Identifier for the parent tab within the TabSectionDTO, facilitating hierarchical organization of tab sections in the user interface. |
Update Tabs¶
HTTP Request
POST /api/entityTab
📋 Description: Creates a new entity tab within the system, enabling users to organize and manage related data efficiently.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the entity tab configuration data, including attributes and settings necessary for effective management and organization within the application. |
Body Parameters
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "entityName": "string",
8 "label": "string",
9 "mandatory": true,
10 "visible": true,
11 "sections": [
12 {
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "name": "string",
17 "label": "string",
18 "mandatory": true,
19 "visible": true,
20 "parentTab": "string"
21 }
22 ]
23 }
24]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Get Tabs Per Entity¶
HTTP Request
GET /api/entityTab/{entityName}
📋 Description: Fetches details of the specified entity, identified by the entity name, to facilitate data retrieval and integration within business applications.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
entityName |
path |
string |
true |
Name of the entity |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "name": "string",
7 "entityName": "string",
8 "label": "string",
9 "mandatory": true,
10 "visible": true,
11 "sections": [
12 {
13 "id": 0,
14 "createdBy": "string",
15 "createdAt": "2019-08-24T14:15:22Z",
16 "name": "string",
17 "label": "string",
18 "mandatory": true,
19 "visible": true,
20 "parentTab": "string"
21 }
22 ]
23 }
24]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing an entity tab configuration, encapsulating essential attributes and settings for effective data management within the application.] |
|
» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
» createdBy |
string |
false |
none |
Username of who created this resource |
» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
» name |
string |
false |
none |
Name of the resource |
» entityName |
string |
false |
none |
Name of the entity |
» label |
string |
false |
none |
Label for the resource |
» mandatory |
boolean |
false |
none |
Indicates whether the associated entity tab is required for completion within the system. |
» visible |
boolean |
false |
none |
Whether this resource is visible |
» sections |
false |
none |
An array of EntityTabDTO objects representing the various sections associated with the entity, facilitating organized data management and retrieval. |
|
»» id |
integer(int64) |
false |
none |
Unique identifier for the resource |
»» createdBy |
string |
false |
none |
Username of who created this resource |
»» createdAt |
string(date-time) |
false |
none |
Timestamp when this resource was created |
»» name |
string |
false |
none |
Name of the resource |
»» label |
string |
false |
none |
Label for the resource |
»» mandatory |
boolean |
false |
none |
Indicates whether the tab section is required for completion in the user interface. |
»» visible |
boolean |
false |
none |
Whether this resource is visible |
»» parentTab |
string |
false |
none |
Identifier for the parent tab within the TabSectionDTO, facilitating hierarchical organization of tab sections in the user interface. |