Additional Field Settings Resource¶
Get Additional Field Settings¶
HTTP Request
GET /api/additionalFieldSettings/{id}
📋 Description: Retrieves the settings for an additional field identified by the specified ID, enabling users to view and manage configuration details relevant to their business processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "entityName": "string",
6 "entityType": "string",
7 "fieldSettings": "string"
8}
Update Additional Field Settings¶
HTTP Request
PUT /api/additionalFieldSettings/{id}
📋 Description: Updates the settings for an additional field identified by the specified ID, allowing for customization and alignment with business requirements.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated settings for the additional field identified by the specified ID, including configuration parameters and their values. |
Body Parameters
1{
2 "id": 0,
3 "createdBy": "string",
4 "createdAt": "2019-08-24T14:15:22Z",
5 "entityName": "string",
6 "entityType": "string",
7 "fieldSettings": "string"
8}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
None |
Delete Additional Field Settings¶
HTTP Request
DELETE /api/additionalFieldSettings/{id}
📋 Description: Deletes the specified additional field setting identified by the unique ID, ensuring the removal of unnecessary or outdated configurations from the system.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
204 |
No Content |
None |
Get All Additional Field Settings¶
HTTP Request
GET /api/additionalFieldSettings
📋 Description: Retrieves the current settings for additional fields, enabling users to customize data input and enhance reporting capabilities.
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 "entityName": "string",
7 "entityType": "string",
8 "fieldSettings": "string"
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the configuration settings for additional fields within the application, enabling customization and enhanced data capture to meet specific business requirements.] |
|
» 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 |
» entityName |
string |
true |
none |
Name of the entity |
» entityType |
string |
true |
none |
Type of the entity |
» fieldSettings |
string |
true |
none |
Configuration settings for additional fields that customize data handling and presentation within the application. |
Create Additional Field Settings¶
HTTP Request
POST /api/additionalFieldSettings
📋 Description: Creates new additional field settings to enhance data customization and improve reporting capabilities within the application.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing the configuration settings for additional fields, including field names, types, and validation rules, to enhance data capture and reporting capabilities. |
Body Parameters
1[
2 {
3 "id": 0,
4 "createdBy": "string",
5 "createdAt": "2019-08-24T14:15:22Z",
6 "entityName": "string",
7 "entityType": "string",
8 "fieldSettings": "string"
9 }
10]
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
201 |
Created |
None |
Get Additional Field Settings By Name And Type¶
HTTP Request
GET /api/additionalFieldSettings/name/{name}/{type}
📋 Description: Retrieves additional field settings based on the specified name and type, enabling users to customize their data management configurations effectively.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
name |
path |
string |
true |
Name of the resource |
type |
path |
string |
true |
Type of the resource |
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 "entityName": "string",
7 "entityType": "string",
8 "fieldSettings": "string"
9 }
10]
Response Schema
Status Code 200
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
anonymous |
false |
none |
[Data transfer object representing the configuration settings for additional fields within the application, enabling customization and enhanced data capture to meet specific business requirements.] |
|
» 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 |
» entityName |
string |
true |
none |
Name of the entity |
» entityType |
string |
true |
none |
Type of the entity |
» fieldSettings |
string |
true |
none |
Configuration settings for additional fields that customize data handling and presentation within the application. |
Get Opetion Type By Entity Name¶
HTTP Request
GET /api/additionalFieldSettings/entityname/{name}
📋 Description: Retrieves additional field settings for a specified entity, allowing users to access configuration details relevant to their business processes.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
name |
path |
string |
true |
Name of the resource |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Inline |
Example Responses
1[
2 "string"
3]