parameters
Operations addressed under /parameters — 21 operations.
document-management-get-parameter-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<ParameterDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
IsActive | bool? | yes |
Name | string | no |
Translations | IEnumerable<ParameterTranslationDto> (collection) | no |
ParameterFields | IEnumerable<ParameterFieldDto> (collection) | no |
Member names are the service's declaration names.
document-management-get-parameter-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.
document-management-create-parameter
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_PRMTR_1 | 400 | PARAMETER_CODE_ALREADY_EXISTS |
document-management-create-parameter › Request Body
codeisActivedocument-management-create-parameter › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
document-management-get-parameter-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 declares its response as ParameterDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
IsActive | bool? | yes |
Name | string | no |
Translations | IEnumerable<ParameterTranslationDto> (collection) | no |
ParameterFields | IEnumerable<ParameterFieldDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_12 | 400 | PARAMETER_CODE_NOT_FOUND |
path Parameters
codequery Parameters
includeInactivedocument-management-get-parameter-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.
document-management-get-parameter-default-value-by-parameter-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 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.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_12 | 400 | PARAMETER_CODE_NOT_FOUND |
ERR_PRMTR_14 | 400 | PARAMETER_DEFAULT_VALUE_BY_CODE_NOT_EXISTS |
path Parameters
codequery Parameters
includeInactivedocument-management-get-parameter-default-value-by-parameter-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.
document-management-get-parameter-value-list-by-parameter-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 declares its response as IEnumerable<ParameterValueDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
ParamKey | int | no |
Context | string | no |
SortOrder | int? | yes |
IsActive | bool? | yes |
Translations | IEnumerable<ParameterValueTranslationDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_12 | 400 | PARAMETER_CODE_NOT_FOUND |
path Parameters
codequery Parameters
includeInactivedocument-management-get-parameter-value-list-by-parameter-code › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
document-management-get-parameter-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 ParameterDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
IsActive | bool? | yes |
Name | string | no |
Translations | IEnumerable<ParameterTranslationDto> (collection) | no |
ParameterFields | IEnumerable<ParameterFieldDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idquery Parameters
includeInactivedocument-management-get-parameter-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.
document-management-update-parameter
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_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
iddocument-management-update-parameter › 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.
document-management-delete-parameter
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_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
iddocument-management-delete-parameter › 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.
document-management-get-parameter-value-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 ParameterDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
IsActive | bool? | yes |
Name | string | no |
Translations | IEnumerable<ParameterTranslationDto> (collection) | no |
ParameterFields | IEnumerable<ParameterFieldDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idquery Parameters
includeInactivedocument-management-get-parameter-value-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.
document-management-create-parameter-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
iddocument-management-create-parameter-value › Request Body
contextisActiveparamKeysortOrderdocument-management-create-parameter-value › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
document-management-get-parameter-default-value
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.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_13 | 400 | PARAMETER_DEFAULT_VALUE_BY_ID_NOT_EXISTS |
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idquery Parameters
includeInactivedocument-management-get-parameter-default-value › 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.
document-management-update-parameter-field-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idfieldValueIddocument-management-update-parameter-field-value › Request Body
fieldValueisActivedocument-management-update-parameter-field-value › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
document-management-delete-parameter-field-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idfieldValueIddocument-management-delete-parameter-field-value › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
document-management-get-parameter-field-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<ParameterFieldDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
IsActive | bool? | yes |
Translations | IEnumerable<ParameterFieldTranslationDto> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idquery Parameters
includeInactivedocument-management-get-parameter-field-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.
document-management-create-parameter-field
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_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
ERR_PRMTR_3 | 400 | PARAMETER_FIELD_CODE_ALREADY_EXISTS |
path Parameters
iddocument-management-create-parameter-field › Request Body
codeisActivedocument-management-create-parameter-field › 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.
document-management-update-parameter-field
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_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
ERR_PRMTR_5 | 400 | PARAMETER_FIELD_NOT_EXISTS |
path Parameters
idfieldIddocument-management-update-parameter-field › Request Body
isActivedocument-management-update-parameter-field › 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.
document-management-delete-parameter-field
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_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
ERR_PRMTR_5 | 400 | PARAMETER_FIELD_NOT_EXISTS |
path Parameters
idfieldIddocument-management-delete-parameter-field › 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.
document-management-update-parameter-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idvalueIddocument-management-update-parameter-value › Request Body
contextisActivesortOrderdocument-management-update-parameter-value › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
document-management-delete-parameter-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idvalueIddocument-management-delete-parameter-value › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
document-management-get-parameter-field-value-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idvalueIdquery Parameters
includeInactivedocument-management-get-parameter-field-value-list › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
document-management-create-parameter-field-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idvalueIddocument-management-create-parameter-field-value › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.