mask-formats
Operations addressed under /mask-formats — 5 operations.
aurax-bff-redirect-get-mask-format-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<MaskFormatDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
ShowFirst | int? | yes |
ShowLast | int? | yes |
DefaultMaskLength | int? | yes |
PreserveLength | bool | no |
MaskChar | string | no |
RegexPattern | string | no |
IsSplitBySpace | bool | no |
Member names are the service's declaration names.
aurax-bff-redirect-get-mask-format-list › 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.
aurax-bff-redirect-create-mask-format
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_140 | 400 | THERE_IS_ALREADY_DEFINEND_MASK_FORMAT_WITH_THIS_CODE | There is already a mask format with this code. |
ERR_CORE_144 | 400 | DEFAULT_MASK_LENGTH_CANNOT_NULL | Default mask length must be greater than 0 if preserve length is false |
ERR_CORE_145 | 400 | DEFAULT_MASK_LENGTH_MUST_BE_NULL | Default mask length must be null if preserve length is true. |
ERR_CORE_24 | 400 | CODE_FIELD_CANNOT_CONTAIN_SPACE | Code field cannot contain space. |
aurax-bff-redirect-create-mask-format › 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.
aurax-bff-redirect-get-mask-format-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 MaskFormatDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
ShowFirst | int? | yes |
ShowLast | int? | yes |
DefaultMaskLength | int? | yes |
PreserveLength | bool | no |
MaskChar | string | no |
RegexPattern | string | no |
IsSplitBySpace | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_141 | 400 | MASK_FORMAT_ID_NOT_FOUND | Mask format cannot be found. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-mask-format-by-id › 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.
aurax-bff-redirect-update-mask-format
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_141 | 400 | MASK_FORMAT_ID_NOT_FOUND | Mask format cannot be found. |
ERR_CORE_144 | 400 | DEFAULT_MASK_LENGTH_CANNOT_NULL | Default mask length must be greater than 0 if preserve length is false |
ERR_CORE_145 | 400 | DEFAULT_MASK_LENGTH_MUST_BE_NULL | Default mask length must be null if preserve length is true. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-update-mask-format › 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.
aurax-bff-redirect-delete-mask-format
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_141 | 400 | MASK_FORMAT_ID_NOT_FOUND | Mask format cannot be found. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-delete-mask-format › 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.