template-types
Operations addressed under /template-types — 20 operations.
Creates document based on defined template with code
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-dynamic-create-document-by-code-with-template-bpmn service definition through POST /api/template-types/designs/create-document-by-code/{templateDesignCode}.
Request and response fields are declared on the routing target create-document-by-code-with-template; this entry declares none of its own.
Response body, read from the service source
The route declares its response as CreateDocumentDto.
| Field | Declared type | Nullable |
|---|---|---|
TemplateDesignCode | string | no |
ContextVersion | string | no |
DocumentContext | string | no |
TemplateDesignContextId | Guid? | yes |
Member names are the service's declaration names.
path Parameters
templateDesignCodeCreates document based on defined template with code › Request Body optional
designVariablesisResponseClearlanguageCodeCreates document based on defined template with code › Responses
Success. An exact, uniquely bound route registration classifies this response as a single-record.
creates document
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
Invokes the aurax-bff-dynamic-create-document-with-template-bpmn service definition through POST /api/template-types/designs/create-document/{templateDesignId}.
Request and response fields are declared on the routing target create-document-with-template-bpmn; this entry declares none of its own.
path Parameters
templateDesignIdcreates document › Request Body optional
designVariablesisResponseClearlanguageCodetemplateDesignContextIdcreates document › Responses
Success. The schema is an anyOf over three envelopes: the record, a bare array of it, and a page {total, data[]} carrying the same record.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object | |
| type = array | |
| type = object · requires: data |
contextVersiondocumentContexttemplateDesignCodeaurax-bff-redirect-get-template-type-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<TemplateTypeDto>.
| Field | Declared type | Nullable |
|---|---|---|
Name | string | no |
Description | string | no |
DocumentFormat | int? | yes |
CategoryType | int? | yes |
Tools | IEnumerable<TemplateTypeToolbarItem> (collection) | no |
Member names are the service's declaration names.
aurax-bff-redirect-get-template-type-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.
aurax-bff-redirect-create-document-by-code-with-template-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
templateDesignCodePresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-create-document-by-code-with-template-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-create-document-with-template-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
templateDesignIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-create-document-with-template-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-template-type-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 TemplateTypeDto.
| Field | Declared type | Nullable |
|---|---|---|
Name | string | no |
Description | string | no |
DocumentFormat | int? | yes |
CategoryType | int? | yes |
Tools | IEnumerable<TemplateTypeToolbarItem> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_TMPLMNG_2 | 400 | TEMPLATE_TYPE_NOT_FOUND | Template type is cannot be found with the given :{0}. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-template-type-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.
aurax-bff-redirect-update-template-type-and-create-delete-template-type-tool-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-update-template-type-and-create-delete-template-type-tool-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-delete-template-type-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-delete-template-type-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-template-design-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<TemplateDesignDto>.
| Field | Declared type | Nullable |
|---|---|---|
TemplateDesignId | Guid? | yes |
Code | string | no |
Description | string | no |
IsImmediateDesign | bool? | yes |
ActiveContextVersion | string | no |
TemplateDesignExtensions | Dictionary<string, string> | no |
TemplateDesignFields | IEnumerable<TemplateDesignFieldItem> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_TMPLMNG_2 | 400 | TEMPLATE_TYPE_NOT_FOUND | Template type is cannot be found with the given :{0}. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-template-design-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.
aurax-bff-redirect-create-template-design-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-create-template-design-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-template-design-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 TemplateDesignDto.
| Field | Declared type | Nullable |
|---|---|---|
TemplateDesignId | Guid? | yes |
Code | string | no |
Description | string | no |
IsImmediateDesign | bool? | yes |
ActiveContextVersion | string | no |
TemplateDesignExtensions | Dictionary<string, string> | no |
TemplateDesignFields | IEnumerable<TemplateDesignFieldItem> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_TMPLMNG_2 | 400 | TEMPLATE_TYPE_NOT_FOUND | Template type is cannot be found with the given :{0}. |
ERR_TMPLMNG_6 | 400 | TEMPLATE_DESIGN_NOT_FOUND | Template design is cannot be found with the given :{0}. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-template-design-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.
aurax-bff-redirect-update-template-design-and-create-template-design-field-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-update-template-design-and-create-template-design-field-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-delete-template-design-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-delete-template-design-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-create-template-design-context-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-create-template-design-context-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-get-template-design-context-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<DesignContextDto>.
| Field | Declared type | Nullable |
|---|---|---|
TemplateDesignContextId | Guid | no |
ContextVersion | string | no |
IsActive | bool | no |
IsDefault | bool? | yes |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_TMPLMNG_2 | 400 | TEMPLATE_TYPE_NOT_FOUND | Template type is cannot be found with the given :{0}. |
ERR_TMPLMNG_6 | 400 | TEMPLATE_DESIGN_NOT_FOUND | Template design is cannot be found with the given :{0}. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignIdPresent in the route template but not declared as a Route-bound field in the catalog.
languageCodePresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-template-design-context-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.
aurax-bff-redirect-get-template-design-context-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 TemplateDesignContextAndEntitiesDto.
| Field | Declared type | Nullable |
|---|---|---|
TemplateDesignContextId | Guid | no |
ContextVersion | string | no |
Context | string | no |
LanguageCode | string | no |
IsActive | bool | no |
IsDefault | bool? | yes |
TemplateDesignFields | List<string> (collection) | no |
TemplateDesignTools | List<string> (collection) | no |
Member names are the service's declaration names.
Error codes this operation is known to raise
| Code | Status | Meaning | Message |
|---|---|---|---|
ERR_TMPLMNG_2 | 400 | TEMPLATE_TYPE_NOT_FOUND | Template type is cannot be found with the given :{0}. |
ERR_TMPLMNG_6 | 400 | TEMPLATE_DESIGN_NOT_FOUND | Template design is cannot be found with the given :{0}. |
ERR_TMPLMNG_8 | 400 | TEMPLATE_DESIGN_CONTEXT_NOT_FOUND | Template design context is cannot be found with the given: {0}. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignIdPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignContextIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-template-design-context-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.
aurax-bff-redirect-update-template-design-context-bpmn
Add Authorization: Bearer <token> yourself — generated samples and Try it do not attach a credential.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignIdPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignContextIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-update-template-design-context-bpmn › Responses
Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.
aurax-bff-redirect-update-template-design-context-status
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_TMPLMNG_2 | 400 | TEMPLATE_TYPE_NOT_FOUND | Template type is cannot be found with the given :{0}. |
ERR_TMPLMNG_6 | 400 | TEMPLATE_DESIGN_NOT_FOUND | Template design is cannot be found with the given :{0}. |
ERR_TMPLMNG_8 | 400 | TEMPLATE_DESIGN_CONTEXT_NOT_FOUND | Template design context is cannot be found with the given: {0}. |
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignIdPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignContextIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-update-template-design-context-status › 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-bff-redirect-get-template-design-fields-and-tools
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 TemplateDesignContextAndEntitiesDto.
| Field | Declared type | Nullable |
|---|---|---|
TemplateDesignContextId | Guid | no |
ContextVersion | string | no |
Context | string | no |
LanguageCode | string | no |
IsActive | bool | no |
IsDefault | bool? | yes |
TemplateDesignFields | List<string> (collection) | no |
TemplateDesignTools | List<string> (collection) | no |
Member names are the service's declaration names.
path Parameters
idPresent in the route template but not declared as a Route-bound field in the catalog.
templateDesignIdPresent in the route template but not declared as a Route-bound field in the catalog.
aurax-bff-redirect-get-template-design-fields-and-tools › 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.