parameters
Operations addressed under /parameters — 19 operations.
foreign-trade-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.
query Parameters
orderByorderSortpageIndexpageSizeforeign-trade-get-parameter-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
foreign-trade-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 |
foreign-trade-create-parameter › Request Body
codeisActiveforeign-trade-create-parameter › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
foreign-trade-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
includeInactiveforeign-trade-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.
foreign-trade-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
includeInactiveforeign-trade-get-parameter-by-id › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
foreign-trade-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
idforeign-trade-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.
foreign-trade-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
idforeign-trade-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.
foreign-trade-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
includeInactiveforeign-trade-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.
foreign-trade-update-parameter-field-value
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_10 | 400 | PARAMETER_FIELD_VALUE_NOT_EXISTS |
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idfieldValueIdforeign-trade-update-parameter-field-value › Request Body
fieldValueisActiveforeign-trade-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.
foreign-trade-delete-parameter-field-value
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_10 | 400 | PARAMETER_FIELD_VALUE_NOT_EXISTS |
ERR_PRMTR_2 | 400 | PARAMETER_ID_NOT_FOUND |
path Parameters
idfieldValueIdforeign-trade-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.
foreign-trade-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
includeInactiveforeign-trade-get-parameter-field-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
foreign-trade-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
idforeign-trade-create-parameter-field › Request Body
codeisActiveforeign-trade-create-parameter-field › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
foreign-trade-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
idfieldIdforeign-trade-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.
foreign-trade-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
idfieldIdforeign-trade-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.
foreign-trade-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 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
includeInactiveforeign-trade-get-parameter-value-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
foreign-trade-create-parameter-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 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
idforeign-trade-create-parameter-value › Request Body
contextisActiveparamKeysortOrderforeign-trade-create-parameter-value › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
foreign-trade-update-parameter-value
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_4 | 400 | PARAMETER_VALUE_NOT_EXISTS |
path Parameters
idvalueIdforeign-trade-update-parameter-value › Request Body
contextisActivesortOrderforeign-trade-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.
foreign-trade-delete-parameter-value
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_4 | 400 | PARAMETER_VALUE_NOT_EXISTS |
path Parameters
idvalueIdforeign-trade-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.
foreign-trade-get-parameter-field-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 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
includeInactiveforeign-trade-get-parameter-field-value-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
foreign-trade-create-parameter-field-value
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_4 | 400 | PARAMETER_VALUE_NOT_EXISTS |
path Parameters
idvalueIdforeign-trade-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.