key-formats
Operations addressed under /key-formats — 11 operations.
business-core-get-key-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<KeyFormatDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Description | string | no |
MaxLength | int | no |
IsActive | bool | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizebusiness-core-get-key-format-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.
codedescriptionidisActivemaxLengthbusiness-core-create-key-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 declares its response as AuraCommandDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_KYGNR_7 | 400 | KEY_FORMAT_CODE_DUPLICATED |
business-core-create-key-format › Request Body
codemaxLengthbusiness-core-create-key-format › 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.
idbusiness-core-get-key-format-id-by-code
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 Guid, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string holding a UUID. This is a complete answer read from the declaration, not a gap.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_KYGNR_1 | 400 | KEY_FORMAT_NOT_FOUND_BY_CODE |
path Parameters
codebusiness-core-get-key-format-id-by-code › 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.
business-core-generate-key
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 string, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string. This is a complete answer read from the declaration, not a gap.
path Parameters
codebusiness-core-generate-key › 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.
business-core-reset-key-format-counter-by-code
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 |
|---|---|---|
ERR_KYGNR_1 | 400 | KEY_FORMAT_NOT_FOUND_BY_CODE |
path Parameters
codebusiness-core-reset-key-format-counter-by-code › 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.
business-core-get-key-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 KeyFormatDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Description | string | no |
MaxLength | int | no |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_KYGNR_16 | 400 | KEY_FORMAT_NOT_FOUND_BY_ID |
path Parameters
idbusiness-core-get-key-format-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.
codedescriptionidisActivemaxLengthbusiness-core-update-key-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 |
|---|---|---|
ERR_KYGNR_16 | 400 | KEY_FORMAT_NOT_FOUND_BY_ID |
path Parameters
idbusiness-core-update-key-format › Request Body
maxLengthbusiness-core-update-key-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.
business-core-get-key-format-item-id-by-key-format-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 KeyFormatItemSummaryListDto.
| Field | Declared type | Nullable |
|---|---|---|
ItemList | IEnumerable<KeyFormatItemSummaryDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_KYGNR_16 | 400 | KEY_FORMAT_NOT_FOUND_BY_ID |
path Parameters
idbusiness-core-get-key-format-item-id-by-key-format-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.
business-core-get-key-format-item-by-key-format-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 KeyFormatItemListDto.
| Field | Declared type | Nullable |
|---|---|---|
ItemList | IEnumerable<KeyFormatItemDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_KYGNR_16 | 400 | KEY_FORMAT_NOT_FOUND_BY_ID |
path Parameters
idbusiness-core-get-key-format-item-by-key-format-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.
business-core-create-key-format-item
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 CreateKeyFormatItemListDto.
| Field | Declared type | Nullable |
|---|---|---|
ItemList | IEnumerable<CreateKeyFormatItemDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_KYGNR_16 | 400 | KEY_FORMAT_NOT_FOUND_BY_ID |
path Parameters
idbusiness-core-create-key-format-item › 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.
business-core-delete-key-format-item
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 |
|---|---|---|
ERR_KYGNR_16 | 400 | KEY_FORMAT_NOT_FOUND_BY_ID |
ERR_KYGNR_3 | 400 | KEY_FORMAT_NOT_EXIST_ITEMS |
path Parameters
iditemIdbusiness-core-delete-key-format-item › 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.