parameters
Operations addressed under /parameters — 21 operations.
aurax-management-get-parameter-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-get-parameter-list service definition through GET /parameters.
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.
query Parameters
orderByorderSortpageIndexpageSizeaurax-management-get-parameter-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.
codeidisActivenameaurax-management-create-parameter
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-create-parameter service definition through POST /parameters.
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 |
aurax-management-create-parameter › Request Body
codeisActiveaurax-management-create-parameter › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-management-get-parameter-by-code
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-get-parameter-by-code service definition through GET /parameters/by-code/{code}.
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
includeInactiveaurax-management-get-parameter-by-code › 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.
codeidisActivenameaurax-management-get-parameter-default-value-by-parameter-code
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-get-parameter-default-value-by-parameter-code service definition through GET /parameters/by-code/{code}/default-value.
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
includeInactiveaurax-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.
aurax-management-get-parameter-value-list-by-parameter-code
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-get-parameter-value-list-by-parameter-code service definition through GET /parameters/by-code/{code}/values.
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
includeInactiveaurax-management-get-parameter-value-list-by-parameter-code › 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.
contextidisActiveparamKeysortOrderaurax-management-get-parameter-by-id
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-get-parameter-by-id service definition through GET /parameters/{id}.
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
includeInactiveaurax-management-get-parameter-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.
codeidisActivenameaurax-management-update-parameter
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-update-parameter service definition through PUT /parameters/{id}.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idaurax-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.
aurax-management-delete-parameter
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-delete-parameter service definition through DELETE /parameters/{id}.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idaurax-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.
aurax-management-get-parameter-default-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-get-parameter-default-value service definition through GET /parameters/{id}/default-value.
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
includeInactiveaurax-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.
aurax-management-update-parameter-field-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-update-parameter-field-value service definition through PUT /parameters/{id}/field-values/{fieldValueId}.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_10 | 400 | PARAMETER_FIELD_VALUE_NOT_EXISTS |
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idfieldValueIdaurax-management-update-parameter-field-value › Request Body
fieldValueisActiveaurax-management-update-parameter-field-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.
aurax-management-delete-parameter-field-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-delete-parameter-field-value service definition through DELETE /parameters/{id}/field-values/{fieldValueId}.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_10 | 400 | PARAMETER_FIELD_VALUE_NOT_EXISTS |
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idfieldValueIdaurax-management-delete-parameter-field-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.
aurax-management-get-parameter-field-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-get-parameter-field-list service definition through GET /parameters/{id}/fields.
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
includeInactiveaurax-management-get-parameter-field-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.
codeidisActiveaurax-management-create-parameter-field
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-create-parameter-field service definition through POST /parameters/{id}/fields.
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
idaurax-management-create-parameter-field › Request Body
codeisActiveaurax-management-create-parameter-field › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-management-update-parameter-field
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-update-parameter-field service definition through PUT /parameters/{id}/fields/{fieldId}.
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
idfieldIdaurax-management-update-parameter-field › Request Body
isActiveaurax-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.
aurax-management-delete-parameter-field
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-delete-parameter-field service definition through DELETE /parameters/{id}/fields/{fieldId}.
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
idfieldIdaurax-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.
aurax-management-get-parameter-value-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-get-parameter-value-list service definition through GET /parameters/{id}/values.
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_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idquery Parameters
includeInactiveaurax-management-get-parameter-value-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.
contextidisActiveparamKeysortOrderaurax-management-create-parameter-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-create-parameter-value service definition through POST /parameters/{id}/values.
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_7 | 400 | PARAMETER_VALUE_WITH_KEY_ALREADY_EXISTS |
path Parameters
idaurax-management-create-parameter-value › Request Body
contextparamKeyisActivesortOrderaurax-management-create-parameter-value › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
aurax-management-update-parameter-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-update-parameter-value service definition through PUT /parameters/{id}/values/{valueId}.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
ERR_PRMTR_4 | 400 | PARAMETER_VALUE_NOT_EXISTS |
path Parameters
idvalueIdaurax-management-update-parameter-value › Request Body
contextisActivesortOrderaurax-management-update-parameter-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.
aurax-management-delete-parameter-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-delete-parameter-value service definition through DELETE /parameters/{id}/values/{valueId}.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
ERR_PRMTR_4 | 400 | PARAMETER_VALUE_NOT_EXISTS |
path Parameters
idvalueIdaurax-management-delete-parameter-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.
aurax-management-get-parameter-field-value-list
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-get-parameter-field-value-list service definition through GET /parameters/{id}/values/{valueId}/field-values.
Response body, read from the service source
The route declares its response as IEnumerable<ParameterFieldValueDto>.
| Field | Declared type | Nullable |
|---|---|---|
ParameterFieldValueId | Guid | no |
ParameterValueId | Guid | no |
ParameterFieldId | Guid | no |
FieldValue | string | no |
IsActive | bool | 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
idvalueIdquery Parameters
includeInactiveaurax-management-get-parameter-field-value-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.
fieldValueisActiveparameterFieldIdparameterFieldValueIdparameterValueIdaurax-management-create-parameter-field-value
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-management-create-parameter-field-value service definition through POST /parameters/{id}/values/{valueId}/field-values.
Error codes this operation is known to raise
| Code | Status | Meaning |
|---|---|---|
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
ERR_PRMTR_4 | 400 | PARAMETER_VALUE_NOT_EXISTS |
path Parameters
idvalueIdaurax-management-create-parameter-field-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.