key-formats
Operations addressed under /key-formats — 10 operations.
collateral-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
filterorderByorderSortpageIndexpageSizecollateral-get-key-format-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
collateral-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 |
collateral-create-key-format › Request Body
codemaxLengthcollateral-create-key-format › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
collateral-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
codecollateral-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.
collateral-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
codecollateral-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.
collateral-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
idcollateral-get-key-format-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
collateral-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
idcollateral-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.
collateral-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
idcollateral-get-key-format-item-id-by-key-format-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
collateral-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
idcollateral-get-key-format-item-by-key-format-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
collateral-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
idcollateral-create-key-format-item › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
collateral-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
iditemIdcollateral-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.