fields
Operations addressed under /fields — 5 operations.
get-field-definition-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as IEnumerable<FieldDefinitionDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
BaseFieldId | Guid? | yes |
Code | string | no |
Name | string | no |
DataType | int | no |
IsArray | bool | no |
IsMaskable | bool | no |
IsEncrypted | bool | no |
ParameterId | Guid? | yes |
ParameterDomainId | Guid? | yes |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-field-definition-list › Responses
Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.
Array of catalog-declared response records.
baseFieldIdcodedataTypePermitted values — validated against the data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | GUID | no label seeded |
2 | INT | no label seeded |
3 | STRING | no label seeded |
4 | NUMERIC | no label seeded |
5 | MONEY | no label seeded |
6 | DATE | no label seeded |
7 | TIMESTAMP | no label seeded |
8 | TIME | no label seeded |
9 | BIGINT | no label seeded |
10 | JSON | no label seeded |
11 | BOOL | en: Boolean · ar: بوليين |
idisArrayisEncryptedisMaskablenameparameterDomainIdparameterIdcreate-field-definition
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route returns AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_129 | 400 | PARAMETER_DOMAIN_ID_CANNOT_BE_NOT_NULL | Parameter domain cannot be left blank. |
ERR_CORE_130 | 400 | PARAMETER_ID_CANNOT_BE_NOT_NULL | Parameter cannot be left blank. |
ERR_CORE_148 | 400 | IS_MASKABLE_MUST_BE_USE_WITH_STRING | Only string type fields can be maskable. |
ERR_CORE_149 | 400 | FIELD_CODE_NOT_CORRECT_FORMAT | Field Code is not in correct format |
ERR_CORE_24 | 400 | CODE_FIELD_CANNOT_CONTAIN_SPACE | Code field cannot contain space. |
ERR_CORE_61 | 400 | FIELD_DEFINITION_CODE_ALREADY_EXISTS | There is already a field with this code. |
ERR_CORE_62 | 400 | BASE_FIELD_DEFINITION_MUST_BE_NOT_NULL | Base field cannot be found. |
create-field-definition › Request Body
codedataTypePermitted values — validated against the data_type parameter.
| Value | Meaning |
|---|---|
1 | GUID |
2 | INT |
3 | STRING |
4 | NUMERIC |
5 | MONEY |
6 | DATE |
7 | TIMESTAMP |
8 | TIME |
9 | BIGINT |
10 | JSON |
11 | Boolean |
Permitted values — validated against the data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | GUID | no label seeded |
2 | INT | no label seeded |
3 | STRING | no label seeded |
4 | NUMERIC | no label seeded |
5 | MONEY | no label seeded |
6 | DATE | no label seeded |
7 | TIMESTAMP | no label seeded |
8 | TIME | no label seeded |
9 | BIGINT | no label seeded |
10 | JSON | no label seeded |
11 | BOOL | en: Boolean · ar: بوليين |
isArrayisEncryptednamebaseFieldIdisMaskableparameterDomainIdparameterIdcreate-field-definition › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
get-field-definition-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Response body, read from the service source
The route declares its response as FieldDefinitionDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
BaseFieldId | Guid? | yes |
Code | string | no |
Name | string | no |
DataType | int | no |
IsArray | bool | no |
IsMaskable | bool | no |
IsEncrypted | bool | no |
ParameterId | Guid? | yes |
ParameterDomainId | Guid? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_66 | 400 | FIELD_ID_IS_NOT_FOUND | Field cannot be found. |
path Parameters
idget-field-definition-by-id › Responses
Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.
baseFieldIdcodedataTypePermitted values — validated against the data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | GUID | no label seeded |
2 | INT | no label seeded |
3 | STRING | no label seeded |
4 | NUMERIC | no label seeded |
5 | MONEY | no label seeded |
6 | DATE | no label seeded |
7 | TIMESTAMP | no label seeded |
8 | TIME | no label seeded |
9 | BIGINT | no label seeded |
10 | JSON | no label seeded |
11 | BOOL | en: Boolean · ar: بوليين |
idisArrayisEncryptedisMaskablenameparameterDomainIdparameterIdupdate-field-definition
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_129 | 400 | PARAMETER_DOMAIN_ID_CANNOT_BE_NOT_NULL | Parameter domain cannot be left blank. |
ERR_CORE_130 | 400 | PARAMETER_ID_CANNOT_BE_NOT_NULL | Parameter cannot be left blank. |
ERR_CORE_148 | 400 | IS_MASKABLE_MUST_BE_USE_WITH_STRING | Only string type fields can be maskable. |
ERR_CORE_54 | 400 | CANNOT_DEFINE_ID_AS_BASEID | Cannot define id as parentId. |
ERR_CORE_62 | 400 | BASE_FIELD_DEFINITION_MUST_BE_NOT_NULL | Base field cannot be found. |
ERR_CORE_66 | 400 | FIELD_ID_IS_NOT_FOUND | Field cannot be found. |
path Parameters
idupdate-field-definition › Request Body
dataTypePermitted values — validated against the data_type parameter.
| Value | Meaning |
|---|---|
1 | GUID |
2 | INT |
3 | STRING |
4 | NUMERIC |
5 | MONEY |
6 | DATE |
7 | TIMESTAMP |
8 | TIME |
9 | BIGINT |
10 | JSON |
11 | Boolean |
Permitted values — validated against the data_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | GUID | no label seeded |
2 | INT | no label seeded |
3 | STRING | no label seeded |
4 | NUMERIC | no label seeded |
5 | MONEY | no label seeded |
6 | DATE | no label seeded |
7 | TIMESTAMP | no label seeded |
8 | TIME | no label seeded |
9 | BIGINT | no label seeded |
10 | JSON | no label seeded |
11 | BOOL | en: Boolean · ar: بوليين |
isArrayisEncryptednamebaseFieldIdisMaskableparameterDomainIdparameterIdupdate-field-definition › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.
delete-field-definition
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_138 | 400 | THIS_RECORD_IS_DEFINED_AS_BASE | This field is defined as base field |
ERR_CORE_66 | 400 | FIELD_ID_IS_NOT_FOUND | Field cannot be found. |
path Parameters
iddelete-field-definition › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as x-aura-code-response.