formulas
Operations addressed under /formulas — 13 operations.
get-formula-definition-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<FormulaDefinitionDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
ResponseFieldId | Guid? | yes |
FormulaType | int | no |
FormulaWorkingType | int | no |
Formula | string | no |
IsActive | bool | no |
Member names are the service's declaration names.
query Parameters
orderByorderSortpageIndexpageSizeget-formula-definition-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.
codeformulaformulaTypePermitted values — validated against the formula_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | boolean_return | no label seeded |
2 | calculation | no label seeded |
3 | assign | no label seeded |
formulaWorkingTypePermitted values — validated against the formula_working_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Lambda Expression | en: Basic formula · tr: Basit formül · ar: الصيغة الأساسية |
2 | Expression | en: Complex formula · tr: Karmaşık formül · ar: معادلة معقدة |
3 | Roslyn Compiler | en: Roslyn Compiler · tr: Doğrudan c# kullanımı · ar: مُجمّع روزلين |
idisActivenameresponseFieldIdcreate-formula-definition
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 AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_143 | 400 | CODE_IS_NOT_VALID | Code is not in correct format. |
ERR_CORE_24 | 400 | CODE_FIELD_CANNOT_CONTAIN_SPACE | Code field cannot contain space. |
ERR_CORE_66 | 400 | FIELD_ID_IS_NOT_FOUND | Field cannot be found. |
ERR_CORE_76 | 400 | FORMULA_DEFINITION_CODE_MUST_BE_UNIQUE | There is already a Formula with this code. |
create-formula-definition › Request Body
codeformulaformulaTypePermitted values — validated against the formula_type parameter.
| Value | Meaning |
|---|---|
1 | boolean_return |
2 | calculation |
3 | assign |
Permitted values — validated against the formula_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | boolean_return | no label seeded |
2 | calculation | no label seeded |
3 | assign | no label seeded |
formulaWorkingTypePermitted values — validated against the formula_working_type parameter.
| Value | Meaning |
|---|---|
1 | Basic formula |
2 | Complex formula |
3 | Roslyn Compiler |
Permitted values — validated against the formula_working_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Lambda Expression | en: Basic formula · tr: Basit formül · ar: الصيغة الأساسية |
2 | Expression | en: Complex formula · tr: Karmaşık formül · ar: معادلة معقدة |
3 | Roslyn Compiler | en: Roslyn Compiler · tr: Doğrudan c# kullanımı · ar: مُجمّع روزلين |
nameresponseFieldIdcreate-formula-definition › 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.
idget-formula-definition-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 FormulaDefinitionDto.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Code | string | no |
Name | string | no |
ResponseFieldId | Guid? | yes |
FormulaType | int | no |
FormulaWorkingType | int | no |
Formula | string | no |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_70 | 400 | FORMULA_DEFINITION_ID_IS_NOT_FOUND | Formula cannot be found. |
path Parameters
idget-formula-definition-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.
codeformulaformulaTypePermitted values — validated against the formula_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | boolean_return | no label seeded |
2 | calculation | no label seeded |
3 | assign | no label seeded |
formulaWorkingTypePermitted values — validated against the formula_working_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Lambda Expression | en: Basic formula · tr: Basit formül · ar: الصيغة الأساسية |
2 | Expression | en: Complex formula · tr: Karmaşık formül · ar: معادلة معقدة |
3 | Roslyn Compiler | en: Roslyn Compiler · tr: Doğrudan c# kullanımı · ar: مُجمّع روزلين |
idisActivenameresponseFieldIdupdate-formula-definition
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 | Message |
|---|---|---|---|
ERR_CORE_66 | 400 | FIELD_ID_IS_NOT_FOUND | Field cannot be found. |
ERR_CORE_70 | 400 | FORMULA_DEFINITION_ID_IS_NOT_FOUND | Formula cannot be found. |
path Parameters
idupdate-formula-definition › Request Body
formulaformulaTypePermitted values — validated against the formula_type parameter.
| Value | Meaning |
|---|---|
1 | boolean_return |
2 | calculation |
3 | assign |
Permitted values — validated against the formula_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | boolean_return | no label seeded |
2 | calculation | no label seeded |
3 | assign | no label seeded |
formulaWorkingTypePermitted values — validated against the formula_working_type parameter.
| Value | Meaning |
|---|---|
1 | Basic formula |
2 | Complex formula |
3 | Roslyn Compiler |
Permitted values — validated against the formula_working_type parameter. The service rejects any other value.
| Value | Token | Labels |
|---|---|---|
1 | Lambda Expression | en: Basic formula · tr: Basit formül · ar: الصيغة الأساسية |
2 | Expression | en: Complex formula · tr: Karmaşık formül · ar: معادلة معقدة |
3 | Roslyn Compiler | en: Roslyn Compiler · tr: Doğrudan c# kullanımı · ar: مُجمّع روزلين |
isActivenameresponseFieldIdupdate-formula-definition › 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.
delete-formula-definition
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 | Message |
|---|---|---|---|
ERR_CORE_70 | 400 | FORMULA_DEFINITION_ID_IS_NOT_FOUND | Formula cannot be found. |
path Parameters
iddelete-formula-definition › 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.
get-formula-definition-request-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<FormulaDefinitionRequestDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
Name | string | no |
FieldId | Guid | no |
DefaultValue | string | no |
Member names are the service's declaration names.
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-formula-definition-request-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-formula-definition-request
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 AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_70 | 400 | FORMULA_DEFINITION_ID_IS_NOT_FOUND | Formula cannot be found. |
path Parameters
idcreate-formula-definition-request › Request Body
fieldIdnamedefaultValuecreate-formula-definition-request › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
update-formula-definition-request
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 | Message |
|---|---|---|---|
ERR_CORE_70 | 400 | FORMULA_DEFINITION_ID_IS_NOT_FOUND | Formula cannot be found. |
path Parameters
idformulaRequestIdupdate-formula-definition-request › Request Body
fieldIdnamedefaultValueupdate-formula-definition-request › 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.
delete-formula-definition-request
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 | Message |
|---|---|---|---|
ERR_CORE_70 | 400 | FORMULA_DEFINITION_ID_IS_NOT_FOUND | Formula cannot be found. |
path Parameters
idformulaRequestIddelete-formula-definition-request › 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.
get-formula-definition-service-map-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<FormulaDefinitionServiceMapDto>.
| Field | Declared type | Nullable |
|---|---|---|
Id | Guid | no |
ServiceId | Guid | no |
IsActive | bool | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_80 | 400 | SERVICE_MAP_COULD_NOT_FOUND_FOR_THIS_FORMULA | Tenant-service map cannot be found for this formula. |
path Parameters
idquery Parameters
orderByorderSortpageIndexpageSizeget-formula-definition-service-map-list › Responses
Success. An exact, uniquely bound route registration classifies this response as a collection.
create-formula-definition-service-map
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 AuraCommandDto<Guid>, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, Id, of type Guid. A caller gets a JSON OBJECT with one field, not a bare value. The field is id on the wire.
| Field | Name on the wire | Declared type | Nullable |
|---|---|---|---|
Id | id | Guid | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_CORE_40 | 400 | SERVICE_ID_IS_NOT_FOUND | Service cannot be found. |
ERR_CORE_70 | 400 | FORMULA_DEFINITION_ID_IS_NOT_FOUND | Formula cannot be found. |
ERR_CORE_71 | 400 | SERVICE_DEFINITION_ID_MUST_BE_UNIQUE | There is already a record for this formula and tenant |
path Parameters
idcreate-formula-definition-service-map › Responses
Success. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.
idIdentifier returned by the command.
update-formula-definition-service-map
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 | Message |
|---|---|---|---|
ERR_CORE_70 | 400 | FORMULA_DEFINITION_ID_IS_NOT_FOUND | Formula cannot be found. |
ERR_CORE_74 | 400 | FORMULA_DEFINITION_MUST_HAVE_SERVICE_MAP | Formula Tenant Service map cannot be found. |
path Parameters
idformulaServiceMapIdupdate-formula-definition-service-map › 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.
delete-formula-definition-service-map
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 | Message |
|---|---|---|---|
ERR_CORE_70 | 400 | FORMULA_DEFINITION_ID_IS_NOT_FOUND | Formula cannot be found. |
ERR_CORE_74 | 400 | FORMULA_DEFINITION_MUST_HAVE_SERVICE_MAP | Formula Tenant Service map cannot be found. |
path Parameters
idformulaServiceMapIddelete-formula-definition-service-map › 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.