openapi: 3.0.3 info: title: 'Stackflows REST API' description: 'Pagination query params are as follows: page[size]=10&page[number]=1' version: 1.0.0 servers: - url: 'https://base.stackflows.com' paths: /api/v2/user: get: operationId: getUserMe summary: Me description: '' parameters: - in: query name: include description: 'One or many of possible includes (reputations, badges, organizations, rank).' example: '"points, points_formatted, reputations"' required: false schema: type: string description: 'One or many of possible includes (reputations, badges, organizations, rank).' example: '"points, points_formatted, reputations"' - in: query name: 'filter[organizations.name]' description: '' example: ipsam required: false schema: type: string description: '' example: ipsam - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Me Response' type: object properties: data: $ref: '#/components/schemas/UserModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: Kyle surname: Schiller email: dejuan15@example.org phone: '+1 (747) 478-7163' email_verified_at: '1992-05-16T03:26:45.000000Z' _key: null tags: - User put: operationId: putUserUpdate summary: Update description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Response' type: object properties: data: $ref: '#/components/schemas/UserModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: Jude surname: Langosh email: jeanette98@example.net phone: 269-595-0116 email_verified_at: '2006-06-09T07:53:00.000000Z' _key: null tags: - User requestBody: required: false content: application/json: schema: type: object properties: organization_ids: type: array description: '' example: null items: type: string organization_unit_ids: type: array description: '' example: null items: type: string name: type: string description: '' example: ratione surname: type: string description: '' example: possimus phone: type: string description: '' example: dolores /api/v2/user/organizations: get: operationId: getUserOrganizationsIndex summary: 'List Organizations' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Organizations Response' type: object properties: data: type: array items: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: - organization_id: 58633cf0-c16a-11ee-b850-9559b4333470 name: en: est description: en: 'Quick, now!'' And Alice was not here before,'' said the Duchess, ''chop off her head!'' Those whom she sentenced were taken into custody by the carrier,'' she thought; ''and how funny it''ll seem to have.' parent_id: 59583c90-c16a-11ee-9675-1d0cfd6336c5 _key: null - organization_id: 595a1280-c16a-11ee-af04-bd8757318f25 name: en: atque description: en: 'White Rabbit put on his flappers, ''--Mystery, ancient and modern, with Seaography: then Drawling--the Drawling-master was an immense length of neck, which seemed to Alice for some time after the.' parent_id: 5a5c8740-c16a-11ee-bc8b-cb43b7f5c152 _key: null tags: - User post: operationId: postUserOrganizationsStore summary: 'Create Organization' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Organization Response' type: object properties: data: $ref: '#/components/schemas/OrganizationModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: 'Organization architecto' country: Guernsey company_code: sb-975 city: 'North Daryl' address: "8943 Greyson Crossing Suite 569\nLake Nikitaside, MI 38663-0512" vat: GB1076508932445 _key: null tags: - User requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must not be greater than 255 characters.' example: jzjy slug: type: string description: 'Must not be greater than 255 characters.' example: ztstc country_id: type: string description: '' example: cupiditate domains: type: array description: '' example: - itaque items: type: string required: - name - slug - country_id '/api/v2/user/organizations/{id}': get: operationId: getUserOrganizationsShow summary: 'View Organization' description: '' parameters: - in: query name: include=members-count description: 'Include members count' example: 16 required: false schema: type: integer description: 'Include members count' example: 16 - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Organization Response' type: object properties: data: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 5a687460-c16a-11ee-ba3e-9104171aa8e9 name: en: autem description: en: 'Alice, whose thoughts were still running on the ground near the house down!'' said the Mock Turtle to sing "Twinkle, twinkle, little bat! How I wonder what they said. The executioner''s argument was.' parent_id: 5b5fda90-c16a-11ee-99bf-093f76e866cd _key: null tags: - User put: operationId: putUserOrganizationsUpdate summary: 'Update Organization' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Organization Response' type: object properties: data: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 5b677220-c16a-11ee-ad57-87bf15a2b503 name: en: asperiores description: en: 'Gryphon answered, very nearly getting up and saying, ''Thank you, it''s a very decided tone: ''tell her something worth hearing. For some minutes the whole place around her became alive with the Queen.' parent_id: 5c5d36d0-c16a-11ee-88fe-b375fd4b45e9 _key: null tags: - User requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: '' example: sunt company_code: type: string description: '' example: enim country_id: type: string description: '' example: null address: type: string description: '' example: mollitia city: type: string description: '' example: esse vat: type: string description: '' example: quia domains: type: array description: '' example: - beatae items: type: string slug: type: string description: '' example: eaque parameters: - in: path name: id description: 'The ID of the organization.' example: 18832260-c7b3-11ed-a964-87702eeadd00 required: true schema: type: string - in: path name: organization description: 'The ID of an organization.' example: 3688e6c0-1a56-11ec-8366 required: true schema: type: string '/api/v2/user/organizations/{slug}/exists': get: operationId: getUserOrganizationsExists summary: 'Exists by slug' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: message: 'Server Error' properties: message: type: string example: 'Server Error' tags: - User parameters: - in: path name: slug description: 'The slug of the organization.' example: 18832260-c7b3-11ed-a964-87702eeadd00 required: true schema: type: string '/api/v2/user/organizations/{organization_id}/users': get: operationId: getUserOrganizationsUsers summary: 'List Organization Users' description: '' parameters: - in: query name: 'filter[similarly_ranked]' description: 'List only similarly ranked to a logged user.' example: true required: false schema: type: boolean description: 'List only similarly ranked to a logged user.' example: true - in: query name: 'filter[active]' description: 'List only active/inactive users.' example: true required: false schema: type: boolean description: 'List only active/inactive users.' example: true - in: query name: 'filter[search]' description: 'List only user that contains specified keyword in their name.' example: John required: false schema: type: string description: 'List only user that contains specified keyword in their name.' example: John - in: query name: include description: 'List of includes separated by comma.' example: organization_units required: false schema: type: string description: 'List of includes separated by comma.' example: organization_units - in: query name: sorts description: 'List of possible sorts by comma.' example: 'rank,-reputation' required: false schema: type: string description: 'List of possible sorts by comma.' example: 'rank,-reputation' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Organization Users Response' type: object properties: data: type: array items: $ref: '#/components/schemas/UserModel' meta: type: object additionalProperties: true examples: example-0: value: data: - name: Icie surname: Monahan email: alfonso73@example.org phone: '(540) 360-8025' email_verified_at: '1974-11-01T11:07:18.000000Z' _key: null - name: Savannah surname: Hickle email: doyle.jerald@example.org phone: '(947) 296-1035' email_verified_at: '1972-10-05T04:47:36.000000Z' _key: null tags: - User parameters: - in: path name: organization_id description: 'The ID of the organization.' example: 18832260-c7b3-11ed-a964-87702eeadd00 required: true schema: type: string '/api/v2/user/organization-domains/{domain}/exists': get: operationId: getUserOrganizationDomainsExists summary: 'Organization domain exists by name' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 500: description: '' content: application/json: schema: type: object example: message: 'Server Error' properties: message: type: string example: 'Server Error' tags: - User parameters: - in: path name: domain description: '' example: 318695e0-03a2-11ee-ad7c-115d06207d80 required: true schema: type: string /api/v2/world/countries: get: operationId: getWorldCountriesIndex summary: 'List Countries' description: '' parameters: - in: query name: include description: 'Possible includes.' example: 'states,cities,timezones,currency' required: false schema: type: string description: 'Possible includes.' example: 'states,cities,timezones,currency' - in: query name: 'filter[name]' description: 'Retrieve countries by name.' example: Estonia required: false schema: type: string description: 'Retrieve countries by name.' example: Estonia - in: query name: 'filter[phone_code]' description: 'Retrieve countries by phone code.' example: '440' required: false schema: type: string description: 'Retrieve countries by phone code.' example: '440' - in: query name: 'filter[region]' description: 'Retrieve countries by a region.' example: Europe required: false schema: type: string description: 'Retrieve countries by a region.' example: Europe - in: query name: 'filter[subregion]' description: 'Retrieve countries by a region.' example: 'Southern Europe' required: false schema: type: string description: 'Retrieve countries by a region.' example: 'Southern Europe' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Countries Response' type: object properties: data: type: array items: $ref: '#/components/schemas/WorldCountryModel' meta: type: object additionalProperties: true examples: example-0: value: data: - iso2: TL name: 'Sao Tome and Principe' status: 1 phone_code: 903 iso3: LBY region: ex subregion: sed _key: null - iso2: GW name: 'Trinidad and Tobago' status: 1 phone_code: 396 iso3: NFK region: dicta subregion: similique _key: null tags: - Open security: [] '/api/v2/world/countries/{id}': get: operationId: getWorldCountriesShow summary: 'View Country' description: '' parameters: - in: query name: include description: 'Possible includes.' example: 'states,cities,timezones,currency' required: false schema: type: string description: 'Possible includes.' example: 'states,cities,timezones,currency' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Country Response' type: object properties: data: $ref: '#/components/schemas/WorldCountryModel' meta: type: object additionalProperties: true examples: example-0: value: data: iso2: AM name: 'American Samoa' status: 1 phone_code: 558 iso3: MOZ region: voluptas subregion: iste _key: null tags: - Open security: [] parameters: - in: path name: id description: 'The ID of the country.' example: consectetur required: true schema: type: string /api/v2/world/states: get: operationId: getWorldStatesIndex summary: 'List States' description: '' parameters: - in: query name: include description: 'Possible includes.' example: 'country,cities' required: false schema: type: string description: 'Possible includes.' example: 'country,cities' - in: query name: 'filter[name]' description: 'Retrieve states by name.' example: Bamyan required: false schema: type: string description: 'Retrieve states by name.' example: Bamyan - in: query name: 'filter[country_code]' description: 'Retrieve states by iso 2 country code.' example: ES required: false schema: type: string description: 'Retrieve states by iso 2 country code.' example: ES - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List States Response' type: object properties: data: type: array items: $ref: '#/components/schemas/WorldStateModel' meta: type: object additionalProperties: true examples: example-0: value: data: - country_id: 2942 name: BSD country_code: FK _key: null - country_id: 2943 name: ETB country_code: AL _key: null tags: - Open security: [] '/api/v2/world/states/{id}': get: operationId: getWorldStatesShow summary: 'View State' description: '' parameters: - in: query name: include description: 'Possible includes.' example: 'country,cities' required: false schema: type: string description: 'Possible includes.' example: 'country,cities' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View State Response' type: object properties: data: $ref: '#/components/schemas/WorldStateModel' meta: type: object additionalProperties: true examples: example-0: value: data: country_id: 2944 name: MZN country_code: MX _key: null tags: - Open security: [] parameters: - in: path name: id description: 'The ID of the state.' example: eaque required: true schema: type: string /api/v2/world/cities: get: operationId: getWorldCitiesIndex summary: 'List Cities' description: '' parameters: - in: query name: include description: 'Possible includes.' example: 'country,state' required: false schema: type: string description: 'Possible includes.' example: 'country,state' - in: query name: 'filter[name]' description: 'Retrieve cities by name.' example: Burrel required: false schema: type: string description: 'Retrieve cities by name.' example: Burrel - in: query name: 'filter[country_code]' description: 'Retrieve cities by iso 2 country code.' example: ES required: false schema: type: string description: 'Retrieve cities by iso 2 country code.' example: ES - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Cities Response' type: object properties: data: type: array items: $ref: '#/components/schemas/WorldCityModel' meta: type: object additionalProperties: true examples: example-0: value: data: - country_id: 2945 state_id: 5502 name: RUB country_code: GT _key: null - country_id: 2947 state_id: 5503 name: ERN country_code: HT _key: null tags: - Open security: [] '/api/v2/world/cities/{id}': get: operationId: getWorldCitiesShow summary: 'View City' description: '' parameters: - in: query name: include description: 'Possible includes.' example: 'country,state' required: false schema: type: string description: 'Possible includes.' example: 'country,state' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View City Response' type: object properties: data: $ref: '#/components/schemas/WorldCityModel' meta: type: object additionalProperties: true examples: example-0: value: data: country_id: 2949 state_id: 5504 name: LKR country_code: BW _key: null tags: - Open security: [] parameters: - in: path name: id description: 'The ID of the city.' example: aut required: true schema: type: string /api/v2/world/timezones: get: operationId: getWorldTimezonesIndex summary: 'List Timezones' description: '' parameters: - in: query name: 'filter[name]' description: 'Retrieve timezones by name.' example: Europe/Tirane required: false schema: type: string description: 'Retrieve timezones by name.' example: Europe/Tirane - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Timezones Response' type: object properties: data: type: array items: $ref: '#/components/schemas/WorldTimezoneModel' meta: type: object additionalProperties: true examples: example-0: value: data: - country_id: 2951 name: BBD _key: null - country_id: 2952 name: JMD _key: null tags: - Open security: [] /api/v2/world/currencies: get: operationId: getWorldCurrenciesIndex summary: 'List Currencies' description: '' parameters: - in: query name: 'filter[name]' description: 'Retrieve currencies by name.' example: Europe/Tirane required: false schema: type: string description: 'Retrieve currencies by name.' example: Europe/Tirane - in: query name: 'filter[code]' description: 'Retrieve currencies by code.' example: Europe/Tirane required: false schema: type: string description: 'Retrieve currencies by code.' example: Europe/Tirane - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Currencies Response' type: object properties: data: type: array items: $ref: '#/components/schemas/WorldCurrencyModel' meta: type: object additionalProperties: true examples: example-0: value: data: - country_id: 2953 name: quos code: BIF precision: 2 symbol: € symbol_native: € symbol_first: '1' decimal_mark: . thousands_separator: ',' _key: null - country_id: 2954 name: officiis code: SHP precision: 2 symbol: € symbol_native: € symbol_first: '1' decimal_mark: . thousands_separator: ',' _key: null tags: - Open security: [] /api/v2/world/languages: get: operationId: getWorldLanguagesIndex summary: 'List Languages' description: '' parameters: - in: query name: 'filter[code]' description: 'Retrieve languages by code.' example: es required: false schema: type: string description: 'Retrieve languages by code.' example: es - in: query name: 'filter[name]' description: 'Retrieve languages by name.' example: Aymara required: false schema: type: string description: 'Retrieve languages by name.' example: Aymara - in: query name: 'filter[name_native]' description: 'Retrieve languages by a native name.' example: 'aymar aru' required: false schema: type: string description: 'Retrieve languages by a native name.' example: 'aymar aru' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Languages Response' type: object properties: data: type: array items: $ref: '#/components/schemas/WorldLanguageModel' meta: type: object additionalProperties: true examples: example-0: value: data: - code: yo name: excepturi name_native: laborum dir: ltr _key: null - code: ka name: qui name_native: non dir: ltr _key: null tags: - Open security: [] '/api/v2/public-business-process-models/{model}': get: operationId: getPublicBusinessProcessModelsShow summary: 'View Business Model' description: '' parameters: - in: query name: 'include=category,diagrams' description: 'Possible includes' example: quae required: false schema: type: string description: 'Possible includes' example: quae - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Model Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelModel' meta: type: object additionalProperties: true examples: example-0: value: data: owner_id: 97b732b0-c169-11ee-aebe-edf182d16795 organization_id: 983154f0-c169-11ee-a7f2-5794f7bb945b category_id: 390045 business_process_id: 31705 name: maxime _lft: 1747651854 _rgt: 1009143906 summary: 'Alice, ''a great girl like you,'' (she might well say this), ''to go on till you come and join the dance. ''"What matters it how far we go?" his scaly friend replied. "There is another shore, you know.' type: process _key: null tags: - Open parameters: - in: path name: model description: '' example: nam required: true schema: type: string '/api/v2/public-business-process-models/{model_id}/form': get: operationId: getPublicBusinessProcessModelsForm summary: 'View Business Process Submission Form' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Process Submission Form Response' type: object properties: data: type: array items: $ref: '#/components/schemas/DataPointCollection' meta: type: object additionalProperties: true examples: example-0: value: data: - [] - [] tags: - Open parameters: - in: path name: model_id description: 'The ID of the model.' example: 01f68d00-40da-11ee-9df1-41abd31f433d required: true schema: type: string '/api/v2/public-business-process-models/{model_id}/start': post: operationId: postPublicBusinessProcessModelsStart summary: 'Start Business Process' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Start Business Process Response' type: object properties: data: $ref: '#/components/schemas/BusinessProcessModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: business_model_id: 9ba2a750-c169-11ee-961e-ddcc110492aa version: 500 versions: [] _key: null tags: - Open requestBody: required: false content: application/json: schema: type: object properties: external_execution_reference: type: string description: '' example: quis submission: type: array description: '' example: null items: type: string parameters: - in: path name: model_id description: 'The ID of the model.' example: 01f68d00-40da-11ee-9df1-41abd31f433d required: true schema: type: string /api/v2/organization-units: get: operationId: getOrganizationUnitsIndex summary: 'List Organization Units' description: '' parameters: - in: query name: 'filter[root]=1' description: 'Retrieve only root nodes' example: sint required: false schema: type: string description: 'Retrieve only root nodes' example: sint - in: query name: 'filter[trashed]=only' description: 'Retrieve only trashed nodes' example: sint required: false schema: type: string description: 'Retrieve only trashed nodes' example: sint - in: query name: 'filter[search]=arb' description: 'Retrieve only those organization units that contains model named with keyword' example: rerum required: false schema: type: string description: 'Retrieve only those organization units that contains model named with keyword' example: rerum - in: query name: include=children description: 'Include children' example: corporis required: false schema: type: string description: 'Include children' example: corporis - in: query name: include=organization description: 'Include organization' example: tempora required: false schema: type: string description: 'Include organization' example: tempora - in: query name: include=business-models description: 'Include business models' example: ea required: false schema: type: string description: 'Include business models' example: ea - in: query name: include=business-models.owner description: 'Include business models owner' example: cum required: false schema: type: string description: 'Include business models owner' example: cum - in: query name: include=business-models.latest-diagram.snapshot description: 'Include business models latest diagram snapshot' example: sed required: false schema: type: string description: 'Include business models latest diagram snapshot' example: sed - in: query name: include=members-count description: 'Include members count' example: 20 required: false schema: type: integer description: 'Include members count' example: 20 - in: query name: include=models-count description: 'Include models count (deprecated)' example: 13 required: false schema: type: integer description: 'Include models count (deprecated)' example: 13 - in: query name: include=business-models-count description: 'Include business models count' example: 17 required: false schema: type: integer description: 'Include business models count' example: 17 - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Organization Units Response' type: object properties: data: type: array items: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: - organization_id: 4918cfa0-c16a-11ee-b778-5bf1618c5a06 name: en: nulla description: en: 'Silence all round, if you could keep it to the Dormouse, after thinking a minute or two the Caterpillar angrily, rearing itself upright as it went. So she was as much as she could do to ask: perhaps.' parent_id: 4a0c1ca0-c16a-11ee-b2db-31f820d6125a _key: null - organization_id: 4a0e2360-c16a-11ee-b5f4-f7e6db02471b name: en: corporis description: en: 'Gryphon interrupted in a bit.'' ''Perhaps it hasn''t one,'' Alice ventured to remark. ''Tut, tut, child!'' said the cook. ''Treacle,'' said a whiting to a mouse: she had a VERY unpleasant state of mind, she.' parent_id: 4afb5650-c16a-11ee-a727-0d80ffcc86ea _key: null tags: - Organization post: operationId: postOrganizationUnitsStore summary: 'Create Organization Unit' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Organization Unit Response' type: object properties: data: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 4b04e130-c16a-11ee-b8b3-2514889351d2 name: en: blanditiis description: en: 'Alice; ''I might as well say that "I see what would happen next. The first witness was the only one who had been broken to pieces. ''Please, then,'' said the last few minutes she heard the Rabbit.' parent_id: 4bf66c60-c16a-11ee-bab2-256d98b7ded3 _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must be at least 3 characters.' example: kjuluwdudgfuwsghbdbfenhapybgehdsemtzyfdrkxohmkyhsmqxr description: type: string description: '' example: 'Voluptatem nulla et quidem.' parent_id: type: string description: '' example: adipisci required: - name '/api/v2/organization-units/{id}': get: operationId: getOrganizationUnitsShow summary: 'View Organization Unit' description: '' parameters: - in: query name: include=children description: 'Include children' example: qui required: false schema: type: string description: 'Include children' example: qui - in: query name: include=organization description: 'Include organization' example: maiores required: false schema: type: string description: 'Include organization' example: maiores - in: query name: include=members-count description: 'Include members count' example: 12 required: false schema: type: integer description: 'Include members count' example: 12 - in: query name: include=models-count description: 'Include models count' example: 15 required: false schema: type: integer description: 'Include models count' example: 15 - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Organization Unit Response' type: object properties: data: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 4bfe5690-c16a-11ee-aaf2-17da4c7e36bb name: en: qui description: en: 'Alice looked at the great hall, with the Duchess, ''chop off her head!'' about once in her life, and had just succeeded in bringing herself down to nine inches high. CHAPTER VI. Pig and Pepper For a.' parent_id: 4cefa2a0-c16a-11ee-9240-27d28d65a931 _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: user_ids: type: array description: 'User IDs to override currently assigned ones.' example: - nam items: type: string required: - user_ids put: operationId: putOrganizationUnitsUpdate summary: 'Update Organization Unit' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Organization Unit Response' type: object properties: data: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 4cf6fde0-c16a-11ee-9969-f7564ca739e9 name: en: error description: en: 'I''m mad. You''re mad.'' ''How do you know why it''s called a whiting?'' ''I never saw one, or heard of uglifying!'' it exclaimed. ''You know what "it" means well enough, when I get SOMEWHERE,'' Alice added.' parent_id: 4df555a0-c16a-11ee-ae9f-970403924f2e _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: 'Must be at least 3 characters.' example: uvwhiirugwwkotntweodhtcubjeztxhqnhppgejgthwetqkxbxajworhpgqbycxeyphmqnjtvkc description: type: string description: '' example: 'Placeat facere repellendus unde assumenda.' parent_id: type: string description: '' example: null user_ids: type: array description: '' example: - veritatis items: type: string delete: operationId: deleteOrganizationUnitsDestroy summary: 'Delete Organization Unit' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Organization Unit Response' type: object properties: data: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 4dfc7640-c16a-11ee-8b19-71b15f9dae1b name: en: non description: en: 'Rabbit say to itself, half to herself, ''whenever I eat one of the thing yourself, some winter day, I will just explain to you to leave it behind?'' She said the sage, as he came, ''Oh! the Duchess, as.' parent_id: 4f23a8c0-c16a-11ee-ad20-9f52b743cf1d _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the organization unit.' example: 0243bf20-312c-11ee-88bb-8bf7d39fb7e1 required: true schema: type: string '/api/v2/organization-units/{organization_unit}/assign': put: operationId: putOrganizationUnitsAssign summary: 'Assign Users to Organization Unit' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Assign Users to Organization Unit Response' type: object properties: data: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 4f2b51c0-c16a-11ee-abb8-0583f891a3a9 name: en: quia description: en: 'Canterbury, found it so yet,'' said the Gryphon. ''Well, I never knew whether it was a little scream of laughter. ''Oh, hush!'' the Rabbit say, ''A barrowful of WHAT?'' thought Alice; ''but a grin without.' parent_id: 502bf660-c16a-11ee-a756-857bfc2ed002 _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: ids: type: array description: '' example: - ut items: type: string parameters: - in: path name: organization_unit description: '' example: 0243bf20-312c-11ee-88bb-8bf7d39fb7e1 required: true schema: type: string '/api/v2/organization-units/{organization_unit}/unassign': put: operationId: putOrganizationUnitsUnassign summary: 'Unassign Users from Organization Unit' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Unassign Users from Organization Unit Response' type: object properties: data: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 5033c940-c16a-11ee-a9fb-b93dbba5f041 name: en: nihil description: en: 'What would become of you? I gave her answer. ''They''re done with a shiver. ''I beg your acceptance of this ointment--one shilling the box-- Allow me to introduce some other subject of conversation.' parent_id: 512bba20-c16a-11ee-b600-69817a9e7f84 _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: ids: type: array description: '' example: - qui items: type: string parameters: - in: path name: organization_unit description: '' example: 0243bf20-312c-11ee-88bb-8bf7d39fb7e1 required: true schema: type: string '/api/v2/organization-units/{organization_unit}/restore': post: operationId: postOrganizationUnitsRestore summary: 'Restore Organization Unit' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Restore Organization Unit Response' type: object properties: data: $ref: '#/components/schemas/OrganizationUnitModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 51376420-c16a-11ee-bba2-fb676d46db80 name: en: dicta description: en: 'Rome--no, THAT''S all wrong, I''m certain! I must have been was not going to shrink any further: she felt that it led into the book her sister on the ground as she could, and waited to see what was on.' parent_id: 5237ba30-c16a-11ee-9b40-594d267a166b _key: null tags: - Organization parameters: - in: path name: organization_unit description: '' example: 0243bf20-312c-11ee-88bb-8bf7d39fb7e1 required: true schema: type: string /api/v2/billing/subscriptions: get: operationId: getBillingSubscriptions summary: 'List Subscriptions' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Subscriptions Response' type: object properties: data: type: array items: $ref: '#/components/schemas/SubscriptionType' meta: type: object additionalProperties: true examples: example-0: value: data: - id: qui createdAt: null startAt: null currentPeriodEndAt: null latestInvoiceId: null status: modi name: null - id: minima createdAt: null startAt: null currentPeriodEndAt: null latestInvoiceId: null status: et name: null tags: - Organization /api/v2/billing/payments: get: operationId: getBillingPayments summary: 'List Payments' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Payments Response' type: object properties: data: type: array items: $ref: '#/components/schemas/PaymentType' meta: type: object additionalProperties: true examples: example-0: value: data: - id: deserunt amountPaid: null pdf: null paidAt: null status: aspernatur subscriptionId: null total: 343428365 - id: a amountPaid: null pdf: null paidAt: null status: alias subscriptionId: null total: 2644172 tags: - Organization /api/v2/environments: get: operationId: getEnvironmentsIndex summary: 'List Environments' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Environments Response' type: object properties: data: type: array items: $ref: '#/components/schemas/EnvironmentModel' meta: type: object additionalProperties: true examples: example-0: value: data: - engine_id: 428a0500-c16a-11ee-88d2-9be6cf6dd0d2 engine_reference: ce087331-fd72-35bb-ba9f-1d0a8bcadb8d production: false name: consequuntur auth_token: 8b880045-fc29-3925-be7f-9ad8dc40e3cb _key: null - engine_id: 430a5ef0-c16a-11ee-997b-0d2d901ade72 engine_reference: 737610f9-7b15-3512-ab40-a97f66321b74 production: true name: optio auth_token: eed93790-7379-3e85-ae77-30c3522d7ad9 _key: null tags: - Organization post: operationId: postEnvironmentsStore summary: 'Create Environment' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Environment Response' type: object properties: data: $ref: '#/components/schemas/CategoryModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 430fa290-c16a-11ee-ae6a-a9f5f65f76b7 slug: neque-enim-exercitationem-totam name: voluptas description: 'Mock Turtle''s heavy sobs. Lastly, she pictured to herself ''It''s the stupidest tea-party I ever saw one that size? Why, it fills the whole thing very absurd, but they were mine before. If I or she.' _lft: 1849150049 _rgt: 544918715 parent_id: 394130 prefix: . _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: libero required: - name delete: operationId: deleteEnvironmentsDeleteBulk summary: 'Delete Environments' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Environments Response' type: object properties: data: type: array items: $ref: '#/components/schemas/CategoryModel' meta: type: object additionalProperties: true examples: example-0: value: data: - organization_id: 43fff260-c16a-11ee-8927-31934de3e50b slug: et-sit-nisi-sed-repellat-quae-exercitationem name: atque description: 'The Gryphon sat up and ran off, thinking while she remembered that she might as well wait, as she leant against a buttercup to rest herself, and shouted out, ''You''d better not do that again!'' which.' _lft: 1419196541 _rgt: 1809564431 parent_id: 394155 prefix: . _key: null - organization_id: 44fed420-c16a-11ee-8821-9f5ee5b345c4 slug: voluptatem-quas-in-fugiat-adipisci-earum-optio-praesentium name: cum description: 'Alice said to herself; ''I should think it would be worth the trouble of getting her hands on her spectacles, and began by taking the little golden key, and unlocking the door opened inwards, and.' _lft: 1812760603 _rgt: 633582351 parent_id: 394180 prefix: . _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: ids: type: array description: 'IDs of records to be deleted.' example: - fugit items: type: string /api/v2/engines: get: operationId: getEngine summary: 'List Engines' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Engines Response' type: object properties: data: type: array items: $ref: '#/components/schemas/EngineModel' meta: type: object additionalProperties: true examples: example-0: value: data: - name: quidem bridge: camunda _key: null - name: sed bridge: camunda _key: null tags: - Organization post: operationId: postEnginesStore summary: 'Create Engine' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Engine Response' type: object properties: data: $ref: '#/components/schemas/EngineModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: placeat bridge: camunda _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: environment_id: type: string description: '' example: null name: type: string description: 'Must not be greater than 255 characters.' example: vknrwbuzjcslefba path: type: string description: 'Must not be greater than 255 characters.' example: lhcyrqbhjpowohpes auth: type: string description: 'Must not be greater than 255 characters.' example: ozal required: - name - path - auth '/api/v2/engines/{id}': get: operationId: getEnginesShow summary: 'View Engine' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Engine Response' type: object properties: data: $ref: '#/components/schemas/EngineModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: et bridge: camunda _key: null tags: - Organization put: operationId: putEnginesUpdate summary: 'Update Engine' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Engine Response' type: object properties: data: $ref: '#/components/schemas/EngineModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: optio bridge: camunda _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: environment_id: type: string description: '' example: null name: type: string description: 'Must not be greater than 255 characters.' example: qryqfqqztzzcl path: type: string description: 'Must not be greater than 255 characters.' example: nkliukxyvirzqyiaq auth: type: string description: 'Must not be greater than 255 characters.' example: etc delete: operationId: deleteEnginesDestroy summary: 'Delete Engine' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Engine Response' type: object properties: data: $ref: '#/components/schemas/EngineModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: ut bridge: camunda _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the engine.' example: unde required: true schema: type: string /api/v2/categories: get: operationId: getCategoriesIndex summary: 'List Categories' description: '' parameters: - in: query name: 'filter[root]' description: 'Use combination with include=children for full tree list.' example: true required: false schema: type: boolean description: 'Use combination with include=children for full tree list.' example: true - in: query name: 'filter[siblings]' description: 'ID of a category which siblings should be retrieved.' example: 145 required: false schema: type: integer description: 'ID of a category which siblings should be retrieved.' example: 145 - in: query name: 'filter[autocomplete]' description: Autocomplete. example: tes required: false schema: type: string description: Autocomplete. example: tes - in: query name: 'filter[search]' description: Search. example: tes required: false schema: type: string description: Search. example: tes - in: query name: 'fields[business-process.latest-diagram]' description: 'Include fields from the latest release record.' example: snapshot required: false schema: type: string description: 'Include fields from the latest release record.' example: snapshot - in: query name: include description: 'Includes relations.' example: 'children,business-models,business-models-count,business-models.comments-count,business-models.owner,business-models.latest-diagram' required: false schema: type: string description: 'Includes relations.' example: 'children,business-models,business-models-count,business-models.comments-count,business-models.owner,business-models.latest-diagram' - in: query name: 'filter[search-business-models]' description: 'Search categories that has models based on specified keyword.' example: 'Some model' required: false schema: type: string description: 'Search categories that has models based on specified keyword.' example: 'Some model' - in: query name: 'filter[organization-units]' description: 'List of organization units ids to retrieve related items.' example: - optio required: false schema: type: array description: 'List of organization units ids to retrieve related items.' example: - optio items: type: string - in: query name: sort description: 'Sort by specific field.' example: 'name,-created_at,-updated_at Sorting example' required: false schema: type: string description: 'Sort by specific field.' example: 'name,-created_at,-updated_at Sorting example' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Categories Response' type: object properties: data: type: array items: $ref: '#/components/schemas/CategoryModel' meta: type: object additionalProperties: true examples: example-0: value: data: - organization_id: f70267d0-c169-11ee-ae8b-6547b56b87d3 slug: expedita-expedita-libero-sunt-tempora-sapiente name: et description: 'And in she went. Once more she found that her neck would bend about easily in any direction, like a snout than a real nose; also its eyes by this time, and was just beginning to see the Mock Turtle.' _lft: 649327519 _rgt: 1891635682 parent_id: 392322 prefix: . _key: null - organization_id: f7e1c670-c169-11ee-8cb5-4f74a80fe282 slug: amet-consequatur-ut-iste-aperiam name: est description: 'Alice''s first thought was that you had been anxiously looking across the garden, and marked, with one finger, as he fumbled over the verses to himself: ''"WE KNOW IT TO BE TRUE--" that''s the jury.' _lft: 584296302 _rgt: 887632511 parent_id: 392347 prefix: . _key: null tags: - Organization post: operationId: postCategoriesStore summary: 'Create Category' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Category Response' type: object properties: data: $ref: '#/components/schemas/CategoryModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: f8df5930-c169-11ee-9399-e777e45e9f04 slug: sunt-placeat-ut-natus-omnis-vel-veniam-ipsa name: mollitia description: 'Duchess sneezed occasionally; and as Alice could not be denied, so she went on, ''What''s your name, child?'' ''My name is Alice, so please your Majesty,'' said Alice desperately: ''he''s perfectly.' _lft: 476949212 _rgt: 305780223 parent_id: 392372 prefix: . _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must be at least 3 characters.' example: btvmhkmmzusjhzxohuytenlstqwwoghlozsujpgbhlrmgynakcrigmzrolcgosjvjsghcsdoblesda description: type: string description: '' example: 'Porro corrupti aut sint debitis sed.' parent_id: type: string description: '' example: null required: - name '/api/v2/categories/{id}': get: operationId: getCategoriesShow summary: 'View Category' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Category Response' type: object properties: data: $ref: '#/components/schemas/CategoryModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: f9c12c40-c169-11ee-9b52-d94b0fbf56e2 slug: est-nisi-numquam-dolor-qui-sed-voluptatum-officia name: nostrum description: 'I don''t care which happens!'' She ate a little shaking among the people near the right size again; and the blades of grass, but she felt unhappy. ''It was the White Rabbit, ''and that''s the queerest.' _lft: 1172836414 _rgt: 1462194827 parent_id: 392397 prefix: . _key: null tags: - Organization put: operationId: putCategoriesUpdate summary: 'Update Category' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Category Response' type: object properties: data: $ref: '#/components/schemas/CategoryModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: faa80100-c169-11ee-9ac6-43e91805d9e5 slug: odit-cupiditate-nostrum-nihil-enim-ratione name: et description: 'Bill,'' she gave her one, they gave him two, You gave us three or more; They all made of solid glass; there was not easy to take out of their wits!'' So she went on growing, and growing, and she could.' _lft: 999058261 _rgt: 1571223090 parent_id: 392422 prefix: . _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: 'Must be at least 3 characters.' example: lqndbjrbqibzghdsxufqiujjunjnscqrqnntbnnmzftovezyskrfjldsrljvekkloalmurodxkr description: type: string description: '' example: 'Ex excepturi quis quia iure explicabo suscipit.' parent_id: type: string description: '' example: null delete: operationId: deleteCategoriesDestroy summary: 'Delete Category' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Category Response' type: object properties: data: $ref: '#/components/schemas/CategoryModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: fb91f960-c169-11ee-9d03-070edab07521 slug: et-ullam-quaerat-consequatur-dolorem-assumenda name: totam description: 'They were indeed a queer-looking party that assembled on the twelfth?'' Alice went on, half to itself, ''Oh dear! Oh dear! I''d nearly forgotten to ask.'' ''It turned into a line along the course, here.' _lft: 1300978262 _rgt: 473905996 parent_id: 392447 prefix: . _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the category.' example: 59 required: true schema: type: integer /api/v2/tags: get: operationId: getTagsIndex summary: 'List Tags' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Tags Response' type: object properties: data: type: array items: $ref: '#/components/schemas/TagModel' meta: type: object additionalProperties: true examples: example-0: value: data: - name: en: occaecati _key: null - name: en: dolores _key: null tags: - Organization post: operationId: postTagsStore summary: 'Create Tag' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Tag Response' type: object properties: data: $ref: '#/components/schemas/TagModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: en: nemo _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: sequi description: type: string description: '' example: 'Minima repellat alias quis vero at.' process_model_ids: type: object description: '' example: null properties: [] required: - name '/api/v2/tags/{id}': get: operationId: getTagsShow summary: 'View Tag' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Tag Response' type: object properties: data: $ref: '#/components/schemas/TagModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: en: fuga _key: null tags: - Organization put: operationId: putTagsUpdate summary: 'Update Tag' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Tag Response' type: object properties: data: $ref: '#/components/schemas/TagModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: en: voluptas _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: rerum description: type: string description: '' example: 'Minus quaerat nemo dolorum ut.' process_model_ids: type: object description: '' example: null properties: [] required: - name delete: operationId: deleteTagsDestroy summary: 'Delete Tag' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Tag Response' type: object properties: data: $ref: '#/components/schemas/TagModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: en: sequi _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the tag.' example: 15 required: true schema: type: integer '/api/v2/decrypt/{share_id}': get: operationId: getShow summary: 'View Share' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Share Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelModel' meta: type: object additionalProperties: true examples: example-0: value: data: owner_id: fc80bd10-c169-11ee-b427-fb19d4c94ba8 organization_id: fcef5880-c169-11ee-843f-3b1520c56310 category_id: 392497 business_process_id: 32140 name: fugit _lft: 1933048385 _rgt: 624469727 summary: 'King said, turning to Alice, she went nearer to watch them, and considered a little, half expecting to see what would be the use of a well--'' ''What did they live at the top of its voice. ''Back to.' type: process _key: null tags: - Organization security: [] parameters: - in: path name: share_id description: 'The ID of the share.' example: 00fe9330-9cfa-11ed-ad91-97af7d471a7e required: true schema: type: string '/api/v2/invitations/{id}': get: operationId: getInvitationsShow summary: 'View Member Invitation' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Member Invitation Response' type: object properties: data: $ref: '#/components/schemas/InvitationModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: fe635380-c169-11ee-acc2-b162fc812209 email: nmetz@example.org type: null context: null user_id: fedd1760-c169-11ee-afc9-a53d3589ae2f expired_at: '2005-03-27T02:36:54.000000Z' active: false _key: null tags: - Organization security: [] parameters: - in: path name: id description: 'The ID of the invitation.' example: 0002f8e0-a090-11ed-85cb-c7881bdeb8dd required: true schema: type: string '/api/v2/invitations/{invitation_id}': delete: operationId: deleteInvitations summary: 'Delete Member Invitation' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Member Invitation Response' type: object properties: data: $ref: '#/components/schemas/InvitationModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: ff515040-c169-11ee-b34c-cb2d2019ebe9 email: dexter15@example.net type: null context: null user_id: ffc4c4a0-c169-11ee-bcf1-9f51f3055c75 expired_at: '2020-01-26T11:40:28.000000Z' active: false _key: null tags: - Organization parameters: - in: path name: invitation_id description: 'The ID of the invitation.' example: 0002f8e0-a090-11ed-85cb-c7881bdeb8dd required: true schema: type: string '/api/v2/invitations/{invitation_id}/accept': post: operationId: postInvitationsAccept summary: 'Accept Member Invitation' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Accept Member Invitation Response' type: object properties: data: $ref: '#/components/schemas/InvitationModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 003b5d90-c16a-11ee-a85c-4dac33f377c6 email: clemens41@example.org type: null context: null user_id: 00b68680-c16a-11ee-a8ec-83ea5ccd92ea expired_at: '1970-10-04T15:20:35.000000Z' active: false _key: null tags: - Organization parameters: - in: path name: invitation_id description: 'The ID of the invitation.' example: 0002f8e0-a090-11ed-85cb-c7881bdeb8dd required: true schema: type: string '/api/v2/unshare/{share_id}': delete: operationId: deleteDestroy summary: 'Delete Share' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Share Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelModel' meta: type: object additionalProperties: true examples: example-0: value: data: owner_id: 013cdb60-c16a-11ee-ba95-7ba41190bd47 organization_id: 01ac6b60-c16a-11ee-8729-ffa2d46e196d category_id: 392619 business_process_id: 32161 name: est _lft: 99258749 _rgt: 712647196 summary: 'It sounded an excellent opportunity for showing off her head!'' Alice glanced rather anxiously at the great puzzle!'' And she thought at first was in the last few minutes that she was saying, and the.' type: process _key: null tags: - Organization parameters: - in: path name: share_id description: 'The ID of the share.' example: 00fe9330-9cfa-11ed-ad91-97af7d471a7e required: true schema: type: string /api/v2/invitations: get: operationId: getInvitationsIndex summary: 'List Invitations' description: '' parameters: - in: query name: 'filter[active]' description: 'List only active tasks.' example: true required: false schema: type: boolean description: 'List only active tasks.' example: true - in: query name: 'filter[accepted]' description: 'List only accepted tasks.' example: true required: false schema: type: boolean description: 'List only accepted tasks.' example: true - in: query name: 'filter[expired]' description: 'List only expired tasks.' example: true required: false schema: type: boolean description: 'List only expired tasks.' example: true - in: query name: 'filter[search]' description: 'List invitations by keyword.' example: lorem required: false schema: type: string description: 'List invitations by keyword.' example: lorem - in: query name: sort description: 'Sort order.' example: '-created_at' required: false schema: type: string description: 'Sort order.' example: '-created_at' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Invitations Response' type: object properties: data: type: array items: $ref: '#/components/schemas/InvitationModel' meta: type: object additionalProperties: true examples: example-0: value: data: - organization_id: 030061c0-c16a-11ee-9969-b3c97b3beac9 email: unader@example.net type: null context: null user_id: 0375a8b0-c16a-11ee-8ad9-d73952e1d846 expired_at: '2016-03-01T09:58:01.000000Z' active: false _key: null - organization_id: 03e5fb90-c16a-11ee-ac9a-c1e54f4a1a0c email: mraz.garret@example.org type: null context: null user_id: 045fdeb0-c16a-11ee-9e8e-fd06879a8692 expired_at: '1994-05-15T09:13:33.000000Z' active: false _key: null tags: - Organization post: operationId: postInvitationsStore summary: 'Invite Members' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Invite Members Response' type: object properties: data: type: array items: $ref: '#/components/schemas/InvitationModel' meta: type: object additionalProperties: true examples: example-0: value: data: - organization_id: 04da6be0-c16a-11ee-9d50-afbe76725396 email: dare.kris@example.com type: null context: null user_id: 0555fbb0-c16a-11ee-ae3f-6b208a1b2442 expired_at: '2009-09-25T10:44:04.000000Z' active: false _key: null - organization_id: 05d6a550-c16a-11ee-9f9b-713704c7de7e email: gardner.beer@example.com type: null context: null user_id: 065b0ff0-c16a-11ee-81a3-3dfd646e76ce expired_at: '2010-04-27T08:34:39.000000Z' active: false _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: emails: type: array description: 'Must be a valid email address.' example: - jose57@example.com items: type: string type: type: string description: 'Must be one of generic.' example: generic context: type: object description: '' example: null properties: [] parent_id: type: string description: '' example: null required: - emails /api/v2/business-models: get: operationId: getBusinessModelsIndex summary: 'List Business Models' description: '' parameters: - in: query name: include description: 'Possible includes.' example: 'owner,company,category,tags,comments-count,tags-count,diagrams' required: false schema: type: string description: 'Possible includes.' example: 'owner,company,category,tags,comments-count,tags-count,diagrams' - in: query name: 'filter[with-any-tags]' description: 'Will return models that has any of specified tags.' example: 'test-tag,another-test-tag' required: false schema: type: string description: 'Will return models that has any of specified tags.' example: 'test-tag,another-test-tag' - in: query name: 'filter[without-any-tags]' description: 'Will return list of all models that has no tags at all.' example: true required: false schema: type: boolean description: 'Will return list of all models that has no tags at all.' example: true - in: query name: 'filter[autocomplete]' description: 'Retrieve list that has "tes" at the start of their name.' example: tes required: false schema: type: string description: 'Retrieve list that has "tes" at the start of their name.' example: tes - in: query name: 'filter[search]' description: 'Retrieve list that has "tes" in their name.' example: tes required: false schema: type: string description: 'Retrieve list that has "tes" in their name.' example: tes - in: query name: 'filter[categories]' description: 'Filter by specific categories.' example: '1,2' required: false schema: type: string description: 'Filter by specific categories.' example: '1,2' - in: query name: 'filter[type]' description: 'Filter by specific type. Example process,decision' example: eos required: false schema: type: string description: 'Filter by specific type. Example process,decision' example: eos - in: query name: 'filter[uncategorized]' description: 'List only uncategorized process models.' example: true required: false schema: type: boolean description: 'List only uncategorized process models.' example: true - in: query name: 'filter[subscribable]' description: 'List only subscribable process models.' example: true required: false schema: type: boolean description: 'List only subscribable process models.' example: true - in: query name: 'filter[manual]' description: 'List manually triggered models.' example: true required: false schema: type: boolean description: 'List manually triggered models.' example: true - in: query name: 'filter[organization-units]' description: 'List of organization units ids to retrieve related items.' example: - assumenda required: false schema: type: array description: 'List of organization units ids to retrieve related items.' example: - assumenda items: type: string - in: query name: 'filter[without-any-organization-units]' description: 'If true business models without any organization units will be listed.' example: true required: false schema: type: boolean description: 'If true business models without any organization units will be listed.' example: true - in: query name: 'filter[production]' description: 'List only production ready process models.' example: true required: false schema: type: boolean description: 'List only production ready process models.' example: true - in: query name: sort description: 'Sorting by specified criteria.' example: 'name,-created_at,-updated_at' required: false schema: type: string description: 'Sorting by specified criteria.' example: 'name,-created_at,-updated_at' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Business Models Response' type: object properties: data: type: array items: $ref: '#/components/schemas/BusinessBaseModelModel' meta: type: object additionalProperties: true examples: example-0: value: data: - owner_id: 9bbca9e0-c169-11ee-8a7f-d1724d7e6846 organization_id: 9c370920-c169-11ee-8bf4-4fb13c07d927 category_id: 390145 business_process_id: 31723 name: accusamus _lft: 1113828305 _rgt: 1828288328 summary: 'All on a three-legged stool in the schoolroom, and though this was not quite like the three gardeners, oblong and flat, with their heads down! I am now? That''ll be a queer thing, to be almost out of.' type: process _key: null - owner_id: 9d9e34f0-c169-11ee-bcf8-f981a728b7d8 organization_id: 9e136100-c169-11ee-b78c-3b10d661b0e2 category_id: 390195 business_process_id: 31732 name: possimus _lft: 1514326361 _rgt: 1278883080 summary: 'Alice. ''Reeling and Writhing, of course, I meant,'' the King said to herself, ''whenever I eat or drink under the sea--'' (''I haven''t,'' said Alice)--''and perhaps you haven''t found it made Alice quite.' type: process _key: null tags: - Organization post: operationId: postBusinessModelsStore summary: 'Create Business Model' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Business Model Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelModel' meta: type: object additionalProperties: true examples: example-0: value: data: owner_id: 9fa59920-c169-11ee-99bd-bb702690efb8 organization_id: a0122b00-c169-11ee-89bb-1354f994fff7 category_id: 390245 business_process_id: 31741 name: commodi _lft: 983784227 _rgt: 1463907613 summary: 'Alice was rather doubtful whether she ought not to be patted on the OUTSIDE.'' He unfolded the paper as he spoke, and the Queen in a moment: she looked back once or twice, and shook itself. Then it.' type: process _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: 'Must be at least 3 characters.' example: jfscfjp type: type: string description: 'Must be one of process or decision.' example: process summary: type: string description: '' example: deleniti category_id: type: string description: '' example: null organization_unit_ids: type: array description: '' example: - omnis items: type: string tag_values: type: array description: '' example: - quae items: type: string required: - name - type delete: operationId: deleteBusinessModelsDeleteBulk summary: 'Delete Business Models' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Business Models Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelModel' meta: type: object additionalProperties: true examples: example-0: value: data: owner_id: a6f0bd30-c169-11ee-bbd6-f92e01384bbf organization_id: a76441f0-c169-11ee-9503-134ea59dc35c category_id: 390445 business_process_id: 31777 name: repellat _lft: 1706764788 _rgt: 455685209 summary: 'YOU, and no more to do with this creature when I was thinking I should understand that better,'' Alice said very humbly; ''I won''t interrupt again. I dare say you never tasted an egg!'' ''I HAVE tasted.' type: process _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: ids: type: array description: 'IDs of records to be deleted.' example: - ut items: type: string '/api/v2/business-models/{id}': get: operationId: getBusinessModelsShow summary: 'View Business Model' description: '' parameters: - in: query name: 'include=owner,organization,category,tags,comments-count,tags-count,diagrams' description: 'Possible includes' example: iure required: false schema: type: string description: 'Possible includes' example: iure - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Model Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelModel' meta: type: object additionalProperties: true examples: example-0: value: data: owner_id: a176b440-c169-11ee-98f1-f7dbcb3c4c94 organization_id: a1ddfd70-c169-11ee-b28d-13386829da78 category_id: 390295 business_process_id: 31750 name: tempora _lft: 646616388 _rgt: 274610784 summary: 'Alice thought), and it said in a hurry. ''No, I''ll look first,'' she said, ''and see whether it''s marked "poison" or not''; for she felt that she tipped over the wig, (look at the top of his head. But.' type: process _key: null tags: - Organization put: operationId: putBusinessModelsUpdate summary: 'Update Business Model' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Business Model Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelModel' meta: type: object additionalProperties: true examples: example-0: value: data: owner_id: a3443d60-c169-11ee-89d9-edecb82b07dd organization_id: a3b38770-c169-11ee-ab5a-1d5fcc29367c category_id: 390345 business_process_id: 31759 name: officiis _lft: 2071252869 _rgt: 1233027753 summary: 'I''m here! Digging for apples, indeed!'' said the Hatter: ''but you could only hear whispers now and then nodded. ''It''s no use denying it. I suppose I ought to be sure; but I THINK I can find it.'' And.' type: process _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: 'Must be at least 3 characters.' example: khprffvobtewmltlmwuaeaaxtxzamskfzqxjkqhdzkxybshgizpngyuzfesheivfukwhswxjoslkufmwtaevocotxi type: type: string description: 'Must be one of process or decision.' example: process summary: type: string description: '' example: amet public: type: boolean description: '' example: true category_id: type: string description: '' example: null organization_unit_ids: type: array description: '' example: - eveniet items: type: string tag_values: type: array description: '' example: - repellat items: type: string delete: operationId: deleteBusinessModelsDestroy summary: 'Delete Business Model' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Business Model Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelModel' meta: type: object additionalProperties: true examples: example-0: value: data: owner_id: a51ac820-c169-11ee-b397-318279772c48 organization_id: a588d290-c169-11ee-9ccc-c70271c037d4 category_id: 390395 business_process_id: 31768 name: iure _lft: 1356956380 _rgt: 2015250325 summary: 'Alice more boldly: ''you know you''re growing too.'' ''Yes, but I hadn''t quite finished my tea when I sleep" is the same solemn tone, ''For the Duchess. ''Everything''s got a moral, if only you can find.' type: process _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the business model.' example: eveniet required: true schema: type: string '/api/v2/business-models/{business_model}/revisions': get: operationId: getBusinessModelsShowRevisions summary: 'List Business Model Diagrams' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Business Model Diagrams Response' type: object properties: data: type: array items: $ref: '#/components/schemas/BusinessBaseModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: - business_model_id: aa9d8990-c169-11ee-88c9-477465b7156e version: 155 versions: [] _key: null - business_model_id: ac820f50-c169-11ee-aafc-5fd0d519a24f version: 333 versions: [] _key: null tags: - Organization post: operationId: postBusinessModelsPostRevision summary: 'Submit Business Model Diagram' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Submit Business Model Diagram Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: business_model_id: ae6d2210-c169-11ee-9aec-5b64d41b76c7 version: 262 versions: [] _key: null tags: - Organization requestBody: required: true content: multipart/form-data: schema: type: object properties: xml: type: string description: 'An xml of a diagram.' example: et snapshot: type: string format: binary description: 'A snapshot image of a diagram' next_version: type: number description: '' example: 4577.4609922 prev_version: type: number description: '' example: 33.02561 required: - xml parameters: - in: path name: business_model description: '' example: natus required: true schema: type: string '/api/v2/business-models/{business_model}/revisions/{revision}': get: operationId: getBusinessModelsShowRevision summary: 'View Business Model Diagram Revision' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Model Diagram Revision Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: business_model_id: b07e06b0-c169-11ee-a57e-01cabccac725 version: 189 versions: [] _key: null tags: - Organization parameters: - in: path name: business_model description: '' example: dolorem required: true schema: type: string - in: path name: revision description: 'The revision.' example: nihil required: true schema: type: string '/api/v2/business-models/{business_model}/tag': post: operationId: postBusinessModelsTag summary: 'Tag Business Model' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Tag Business Model Response' type: object properties: data: $ref: '#/components/schemas/TagModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: en: sequi _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: tags: type: array description: 'List of tags, like [adsgasd, asdgasdg, asdgasdg]' example: - perferendis items: type: string type: type: string description: 'Type of tag to work with, only one type is allowed at a single request' example: et parameters: - in: path name: business_model description: '' example: eveniet required: true schema: type: string '/api/v2/business-models/{business_model}/share': post: operationId: postBusinessModelsShare summary: 'Share Business Model' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Share Business Model Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelModel' meta: type: object additionalProperties: true examples: example-0: value: data: owner_id: b09d1100-c169-11ee-88ac-1d7a47c3606f organization_id: b11cbf20-c169-11ee-9028-35ad6c2638ea category_id: 390695 business_process_id: 31822 name: non _lft: 27779355 _rgt: 1243061108 summary: 'The other side of WHAT? The other guests had taken his watch out of the court. (As that is rather a hard word, I will tell you how it was certainly not becoming. ''And that''s the queerest thing about.' type: process _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: is_public: type: boolean description: '' example: false expire_date: type: string description: 'Must be a valid date. Must be a date after today.' example: '2107-11-25' required: - is_public parameters: - in: path name: business_model description: '' example: sequi required: true schema: type: string '/api/v2/business-models/{business_model}/comments': get: operationId: getBusinessModelsComments summary: 'List Business Model Comments' description: '' parameters: - in: query name: include description: 'Specify a list of includes.' example: commenter required: false schema: type: string description: 'Specify a list of includes.' example: commenter - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Business Model Comments Response' type: object properties: data: type: array items: $ref: '#/components/schemas/CommentModel' meta: type: object additionalProperties: true examples: example-0: value: data: - parent_id: 2707 commentable_id: b77ae9c0-c169-11ee-886b-9f22a847cc2f commenter_id: b7873d30-c169-11ee-9075-0114c66b325f commentable_type: App\Models\BusinessBaseModel comment: 'Cheshire cat,'' said the Duchess. An invitation from the change: and Alice could not stand, and she had nibbled some more bread-and-butter--'' ''But what am I to do?'' said Alice. ''Of course you know.' status: 1 _key: null - parent_id: 2708 commentable_id: bdeafac0-c169-11ee-bda5-25f53a592f4a commenter_id: bdf78d90-c169-11ee-8dfc-fd5d4762d1d7 commentable_type: App\Models\BusinessBaseModel comment: 'Mock Turtle. ''Very much indeed,'' said Alice. ''Exactly so,'' said the Hatter instead!'' CHAPTER VII. A Mad Tea-Party There was no time she''d have everybody executed, all round. ''But she must have got.' status: 0 _key: null tags: - Organization parameters: - in: path name: business_model description: '' example: eligendi required: true schema: type: string /api/v2/business-model-diagrams: get: operationId: getBusinessModelDiagramsIndex summary: 'List Business Model Diagrams' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Business Model Diagrams Response' type: object properties: data: type: array items: $ref: '#/components/schemas/BusinessBaseModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: - business_model_id: c128fe60-c169-11ee-929a-21450a9745f2 version: 957 versions: [] _key: null - business_model_id: c3655ae0-c169-11ee-86f2-53517ee903f8 version: 672 versions: [] _key: null tags: - Organization post: operationId: postBusinessModelDiagramsStore summary: 'Create Business Model Diagram' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Business Model Diagram Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: business_model_id: c57ac380-c169-11ee-8086-03e3a9d5dc11 version: 603 versions: [] _key: null tags: - Organization requestBody: required: true content: multipart/form-data: schema: type: object properties: xml: type: string description: '' example: iste next_version: type: number description: '' example: 134.6862 prev_version: type: number description: '' example: 469.183957679 snapshot: type: string format: binary description: 'of the process diagram' business_model_id: type: string description: '' example: qui required: - xml - business_model_id '/api/v2/business-model-diagrams/{id}': get: operationId: getBusinessModelDiagramsShow summary: 'View Business Model Diagram' description: '' parameters: - in: query name: 'include=snapshots,publications,publications.statistics' description: 'Possible includes' example: qui required: false schema: type: string description: 'Possible includes' example: qui - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Model Diagram Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: business_model_id: c77d5270-c169-11ee-b4cf-c57441862bd9 version: 435 versions: [] _key: null tags: - Organization delete: operationId: deleteBusinessModelDiagramsDestroy summary: 'Delete Business Model Diagram' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Business Model Diagram Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: business_model_id: c9a2cca0-c169-11ee-99e5-31f34b785e34 version: 248 versions: [] _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the business model diagram.' example: ratione required: true schema: type: string '/api/v2/business-model-diagrams/{business_model_diagram}/publish': post: operationId: postBusinessModelDiagramsPublish summary: 'Publish Business Model Diagram' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Publish Business Model Diagram Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: business_model_id: cbb65130-c169-11ee-b849-7b9b838b9fda version: 612 versions: [] _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: environment_ids: type: array description: '' example: null items: type: string parameters: - in: path name: business_model_diagram description: '' example: quibusdam required: true schema: type: string '/api/v2/business-model-diagrams/{business_model_diagram}/snapshots/{snapshot_id}': get: operationId: getBusinessModelDiagramsSnapshotsDownloadSingle summary: 'Download Business Model Diagram Snapshot' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Download Business Model Diagram Snapshot Response' type: object properties: data: type: array items: $ref: '#/components/schemas/BusinessBaseModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: - business_model_id: cdc73db0-c169-11ee-b156-7da5e2e3cafa version: 988 versions: [] _key: null - business_model_id: cfe515c0-c169-11ee-a777-0dfcf8ea5960 version: 923 versions: [] _key: null tags: - Organization parameters: - in: path name: business_model_diagram description: '' example: error required: true schema: type: string - in: path name: snapshot_id description: 'The ID of the snapshot.' example: 4 required: true schema: type: integer '/api/v2/business-model-diagrams/{business_model_diagram_id}/comments': get: operationId: getBusinessModelDiagramsCommentsIndex summary: 'List Business Model Diagram Comments' description: '' parameters: - in: query name: include description: 'Specify a list of includes.' example: commenter required: false schema: type: string description: 'Specify a list of includes.' example: commenter - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Business Model Diagram Comments Response' type: object properties: data: type: array items: $ref: '#/components/schemas/CommentModel' meta: type: object additionalProperties: true examples: example-0: value: data: - parent_id: 2709 commentable_id: d4c70100-c169-11ee-8ede-a30d630583da commenter_id: d4d411b0-c169-11ee-88cb-151af6494e07 commentable_type: App\Models\BusinessBaseModel comment: 'Dinah stop in the world she was as much right,'' said the Hatter, it woke up again with a growl, And concluded the banquet--] ''What IS the same tone, exactly as if she had never before seen a good.' status: 0 _key: null - parent_id: 2710 commentable_id: da1a6380-c169-11ee-a43f-fbfd13c6699a commenter_id: da26a2b0-c169-11ee-914c-1398f534d3ca commentable_type: App\Models\BusinessBaseModel comment: 'I will just explain to you how the game was in a trembling voice, ''--and I hadn''t mentioned Dinah!'' she said to herself, and shouted out, ''You''d better not talk!'' said Five. ''I heard every word you.' status: 0 _key: null tags: - Organization post: operationId: postBusinessModelDiagramsCommentsStore summary: 'Create Business Model Diagram Comment' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Business Model Diagram Comment Response' type: object properties: data: $ref: '#/components/schemas/CommentModel' meta: type: object additionalProperties: true examples: example-0: value: data: parent_id: 2711 commentable_id: df417560-c169-11ee-89ab-17f33e30cb14 commenter_id: df4d9730-c169-11ee-9f64-41c3d23c3d56 commentable_type: App\Models\BusinessBaseModel comment: 'As she said to Alice, and she tried the roots of trees, and I''ve tried hedges,'' the Pigeon in a helpless sort of people live about here?'' ''In THAT direction,'' the Cat said, waving its right ear and.' status: 0 _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: comment: type: string description: '' example: aut parent: type: integer description: '' example: 15 required: - comment parameters: - in: path name: business_model_diagram_id description: 'The ID of the business model diagram.' example: quisquam required: true schema: type: string '/api/v2/business-model-diagrams/{business_model_diagram_id}/comments/{id}': delete: operationId: deleteBusinessModelDiagramsCommentsDestroy summary: 'Delete Business Model Diagram Comment' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Business Model Diagram Comment Response' type: object properties: data: $ref: '#/components/schemas/CommentModel' meta: type: object additionalProperties: true examples: example-0: value: data: parent_id: 2712 commentable_id: e4a0f250-c169-11ee-b04b-67cbf76a04c3 commenter_id: e4ad4400-c169-11ee-b0bf-f9f208607f61 commentable_type: App\Models\BusinessBaseModel comment: 'Knave of Hearts, who only bowed and smiled in reply. ''Please come back again, and the other bit. Her chin was pressed so closely against her foot, that there was nothing on it were white, but there.' status: 0 _key: null tags: - Organization parameters: - in: path name: business_model_diagram_id description: 'The ID of the business model diagram.' example: doloremque required: true schema: type: string - in: path name: id description: 'The ID of the comment.' example: 1 required: true schema: type: integer - in: path name: diagram description: 'The ID of a diagram.' example: 3688e6c0-1a56-11ec-8366 required: true schema: type: string - in: path name: comment description: 'The ID of a comment.' example: 3688e6c0-1a56-11ec-8366 required: true schema: type: string /api/v2/business-model-publications: get: operationId: getBusinessModelPublicationsIndex summary: 'List Business Model Publications' description: '' parameters: - in: query name: include description: 'Possible includes.' example: 'diagram,diagram.model' required: false schema: type: string description: 'Possible includes.' example: 'diagram,diagram.model' - in: query name: 'filter[business-model-diagram]' description: 'Filter by diagram id.' example: 5445fd-2454554-fddffd-5445 required: false schema: type: string description: 'Filter by diagram id.' example: 5445fd-2454554-fddffd-5445 - in: query name: 'filter[manual]' description: 'List manually triggered process publications.' example: true required: false schema: type: boolean description: 'List manually triggered process publications.' example: true - in: query name: 'filter[eligible]' description: 'List only eligible records.' example: true required: false schema: type: boolean description: 'List only eligible records.' example: true - in: query name: 'filter[production]' description: 'List only production ready process publications.' example: true required: false schema: type: boolean description: 'List only production ready process publications.' example: true - in: query name: 'filter[type]' description: 'List publications by model type (process, decision).' example: process required: false schema: type: string description: 'List publications by model type (process, decision).' example: process - in: query name: 'filter[latest]' description: 'List only latest publications.' example: true required: false schema: type: boolean description: 'List only latest publications.' example: true - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Business Model Publications Response' type: object properties: data: type: array items: $ref: '#/components/schemas/BusinessBaseModelPublicationModel' meta: type: object additionalProperties: true examples: example-0: value: data: - business_model_diagram_id: e7401a70-c169-11ee-9a43-8b857adc6f50 engine_deployment_reference: f8c03421-9d4e-3d6f-ad35-bb48babb7ca9 engine_diagram_reference: 124004ce-e3fe-3f87-9b50-eb6ef85574b2 engine_model_reference: Process_AccusamusEtFuga. _key: null - business_model_diagram_id: e932d020-c169-11ee-8add-87e8d0c71c66 engine_deployment_reference: 447e9ef5-b191-31ee-b898-7d1966726d98 engine_diagram_reference: 6f493c78-18df-385f-8856-ed9350e2e905 engine_model_reference: Process_AccusantiumEaque. _key: null tags: - Organization '/api/v2/business-model-publications/{id}': get: operationId: getBusinessModelPublicationsShow summary: 'View Business Model Publication' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Model Publication Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelPublicationModel' meta: type: object additionalProperties: true examples: example-0: value: data: business_model_diagram_id: eb1e4050-c169-11ee-b83d-9764a0d7b8fe engine_deployment_reference: b60df4e8-3e15-3e25-b318-ecd5a01e2683 engine_diagram_reference: 2b2c0ee0-d46b-3fa9-869f-7c04e246e3d0 engine_model_reference: Process_PerspiciatisNisi. _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the business model publication.' example: et required: true schema: type: string /api/v2/business-model-exceptions: get: operationId: getBusinessModelExceptionsIndex summary: 'List Business Model Exceptions' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Business Model Exceptions Response' type: object properties: data: type: array items: $ref: '#/components/schemas/BusinessBaseModelExceptionModel' meta: type: object additionalProperties: true examples: example-0: value: data: - organization_id: eb27deb0-c169-11ee-b701-c748e1ca410f source: en: delectus solution: en: nostrum consequences: en: commodi incidence: high impact: low causative_organization_unit_id: ebff43e0-c169-11ee-b864-73e3af0879f8 responsible_organization_unit_id: ec793e60-c169-11ee-82ae-9d69de25c8de incidence_options: - very_low - low - medium - high - very_high impact_options: - none - low - medium - high _key: null - organization_id: ec7a7740-c169-11ee-8947-67456e798a50 source: en: minus solution: en: aut consequences: en: fugiat incidence: low impact: low causative_organization_unit_id: ed6849e0-c169-11ee-8de7-117493b65c73 responsible_organization_unit_id: edde6cb0-c169-11ee-b4fc-39973728344d incidence_options: - very_low - low - medium - high - very_high impact_options: - none - low - medium - high _key: null tags: - Organization '/api/v2/business-model-exceptions/{id}': get: operationId: getBusinessModelExceptionsShow summary: 'View Business Model Exception' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Model Exception Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelExceptionModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: edeac420-c169-11ee-8d65-71e508b380b0 source: en: placeat solution: en: et consequences: en: impedit incidence: very_high impact: medium causative_organization_unit_id: eecbedd0-c169-11ee-9018-bf3009f7d1ed responsible_organization_unit_id: ef4d5e00-c169-11ee-b8cc-99e6884964fe incidence_options: - very_low - low - medium - high - very_high impact_options: - none - low - medium - high _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the business model exception.' example: fugiat required: true schema: type: string /api/v2/business-process-model-publications: get: operationId: getBusinessProcessModelPublicationsIndex summary: 'List Business Process Model Publications' description: '' parameters: - in: query name: append description: 'Possible appends.' example: 'statistics,outliers' required: false schema: type: string description: 'Possible appends.' example: 'statistics,outliers' - in: query name: include description: 'Possible includes.' example: 'diagram,diagram.model' required: false schema: type: string description: 'Possible includes.' example: 'diagram,diagram.model' - in: query name: 'filter[business-model-diagram]' description: 'Filter by diagram id.' example: 5445fd-2454554-fddffd-5445 required: false schema: type: string description: 'Filter by diagram id.' example: 5445fd-2454554-fddffd-5445 - in: query name: 'filter[manual]' description: 'List manually triggered process publications.' example: true required: false schema: type: boolean description: 'List manually triggered process publications.' example: true - in: query name: 'filter[production]' description: 'List only production ready process publications.' example: true required: false schema: type: boolean description: 'List only production ready process publications.' example: true - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Business Process Model Publications Response' type: object properties: data: type: array items: $ref: '#/components/schemas/BusinessBaseModelPublicationModel' meta: type: object additionalProperties: true examples: example-0: value: data: - business_model_diagram_id: f13363a0-c169-11ee-a104-9f41a69cfc79 engine_deployment_reference: fc0ea076-458b-3a4c-91c5-f826580ba456 engine_diagram_reference: 8044fe79-f1b7-3705-99df-f8523a753bed engine_model_reference: Process_AtqueEtPariatur. _key: null - business_model_diagram_id: f32ffb00-c169-11ee-ac62-67698d5569c1 engine_deployment_reference: 6c8e2511-0675-39f1-b705-9a592b9656a9 engine_diagram_reference: ee874a31-c372-385e-878a-b5b74dd17ffe engine_model_reference: Process_ExercitationemEt. _key: null tags: - Organization '/api/v2/business-process-model-publications/{publication}': get: operationId: getBusinessProcessModelPublicationsShow summary: 'View Business Process Model Publication' description: '' parameters: - in: query name: append description: 'Possible appends.' example: 'statistics,outliers' required: false schema: type: string description: 'Possible appends.' example: 'statistics,outliers' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Process Model Publication Response' type: object properties: data: $ref: '#/components/schemas/BusinessBaseModelPublicationModel' meta: type: object additionalProperties: true examples: example-0: value: data: business_model_diagram_id: f517cec0-c169-11ee-9e86-cf9d5a9f5817 engine_deployment_reference: 983f4b6b-dc0b-3a5c-b67a-cb76e0674b07 engine_diagram_reference: efd0c455-4e3a-3304-b180-cb93f80b5f29 engine_model_reference: Process_EaQuiDoloribus. _key: null tags: - Organization parameters: - in: path name: publication description: '' example: corrupti required: true schema: type: string '/api/v2/business-process-model-publications/{publication_id}/form': get: operationId: getBusinessProcessModelPublicationsForm summary: 'View Business Process Submission Form' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Process Submission Form Response' type: object properties: data: type: array items: $ref: '#/components/schemas/DataPointCollection' meta: type: object additionalProperties: true examples: example-0: value: data: - [] - [] tags: - Organization parameters: - in: path name: publication_id description: 'The ID of the publication.' example: consequuntur required: true schema: type: string '/api/v2/business-process-model-publications/{publication_id}/start': post: operationId: postBusinessProcessModelPublicationsStart summary: 'Start Business Process' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Start Business Process Response' type: object properties: data: $ref: '#/components/schemas/BusinessProcessModelDiagramModel' meta: type: object additionalProperties: true examples: example-0: value: data: business_model_id: f6f91fc0-c169-11ee-984a-f95e601f27d5 version: 640 versions: [] _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: submission: type: array description: '' example: - temporibus items: type: string required: - submission parameters: - in: path name: publication_id description: 'The ID of the publication.' example: accusamus required: true schema: type: string /api/v2/connectors/profiles: get: operationId: getConnectorsProfilesIndex summary: 'List Connector Profiles' description: '' parameters: - in: query name: 'filter[trashed]' description: 'List only trashed profiles.' example: 'with,only' required: false schema: type: string description: 'List only trashed profiles.' example: 'with,only' - in: query name: sort description: 'Sort order.' example: '-created_at' required: false schema: type: string description: 'Sort order.' example: '-created_at' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Connector Profiles Response' type: object properties: data: type: array items: $ref: '#/components/schemas/ConnectorProfileModel' meta: type: object additionalProperties: true examples: example-0: value: data: - organization_id: 06f2a780-c16a-11ee-80fa-7bf3a00f6e62 label: modi name: make version: v2 config: [] actions: - name: exec_scenario externalName: exec_scenario _key: null - organization_id: 077cea50-c16a-11ee-98c7-b3d54b37c521 label: omnis name: make version: v2 config: [] actions: - name: exec_scenario externalName: exec_scenario _key: null tags: - Organization post: operationId: postConnectorsProfilesStore summary: 'Create Connector Profile' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Connector Profile Response' type: object properties: data: $ref: '#/components/schemas/ConnectorProfileModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 07f8c8c0-c16a-11ee-b1bc-e390eff833ed label: expedita name: make version: v2 config: [] actions: - name: exec_scenario externalName: exec_scenario _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: label: type: string description: '' example: aut name: type: string description: '' example: officia version: type: string description: '' example: suscipit config: type: object description: '' example: null properties: [] required: - label - name '/api/v2/connectors/profiles/{id}': get: operationId: getConnectorsProfilesShow summary: 'View Connector Profile' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Connector Profile Response' type: object properties: data: $ref: '#/components/schemas/ConnectorProfileModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 08740e40-c16a-11ee-b8b2-9fa5421baebe label: cupiditate name: make version: v2 config: [] actions: - name: exec_scenario externalName: exec_scenario _key: null tags: - Organization put: operationId: putConnectorsProfilesUpdate summary: 'Update Connector Profile' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Connector Profile Response' type: object properties: data: $ref: '#/components/schemas/ConnectorProfileModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 08e995a0-c16a-11ee-b6b2-df8601fc7d59 label: deserunt name: make version: v2 config: [] actions: - name: exec_scenario externalName: exec_scenario _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: label: type: string description: '' example: qui name: type: string description: '' example: magni version: type: string description: '' example: molestiae config: type: object description: '' example: null properties: [] delete: operationId: deleteConnectorsProfilesDestroy summary: 'Delete Connector Profile' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Connector Profile Response' type: object properties: data: $ref: '#/components/schemas/ConnectorProfileModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 095818e0-c16a-11ee-945b-ef23c33bc23b label: nemo name: make version: v2 config: [] actions: - name: exec_scenario externalName: exec_scenario _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the profile.' example: numquam required: true schema: type: string '/api/v2/connectors/profiles/{profile_id}/restore': post: operationId: postConnectorsProfilesRestore summary: 'Restore Connector Profile' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Restore Connector Profile Response' type: object properties: data: $ref: '#/components/schemas/ConnectorProfileModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 09d26dc0-c16a-11ee-94e7-29af20dff3ec label: est name: make version: v2 config: [] actions: - name: exec_scenario externalName: exec_scenario _key: null tags: - Organization parameters: - in: path name: profile_id description: 'The ID of the profile.' example: facilis required: true schema: type: string '/api/v2/connectors/profiles/{profile_id}/action/{action}/config-fields': get: operationId: getConnectorsProfilesListActionConfigFields summary: 'List Connector Profile Action Config Fields' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 403: description: '' content: application/json: schema: type: object example: message: 'Tenant header is missing or is invalid' properties: message: type: string example: 'Tenant header is missing or is invalid' tags: - Organization parameters: - in: path name: profile_id description: 'The ID of the profile.' example: et required: true schema: type: string - in: path name: action description: 'The action.' example: alias required: true schema: type: string /api/v2/connectors/applications: get: operationId: getConnectorsApplicationsIndex summary: 'List Connector Applications' description: '' parameters: - in: query name: 'filter[connector_profile_id]' description: 'List applications for a specific profile.' example: lorem required: false schema: type: string description: 'List applications for a specific profile.' example: lorem - in: query name: 'filter[business_model_id]' description: 'List applications for a specific model.' example: lorem required: false schema: type: string description: 'List applications for a specific model.' example: lorem - in: query name: 'filter[service_task_topic]' description: 'List applications for a specific service task topic.' example: lorem required: false schema: type: string description: 'List applications for a specific service task topic.' example: lorem - in: query name: 'filter[action_reference]' description: 'List applications for a specific action.' example: lorem required: false schema: type: string description: 'List applications for a specific action.' example: lorem - in: query name: 'filter[search]' description: 'List applications by a specific keyword.' example: lorem required: false schema: type: string description: 'List applications by a specific keyword.' example: lorem - in: query name: sort description: 'Sort order.' example: '-created_at' required: false schema: type: string description: 'Sort order.' example: '-created_at' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Connector Applications Response' type: object properties: data: type: array items: $ref: '#/components/schemas/ConnectorApplicationModel' meta: type: object additionalProperties: true examples: example-0: value: data: - connector_profile_id: 0acc1770-c16a-11ee-a0f6-a1e088e22f28 business_model_id: 0cd50ef0-c16a-11ee-96b8-69730d3fb04b business_model_diagram_id: 0f01c930-c16a-11ee-bb26-051938d6b6ba service_task_topic: DICTA_VOLUPTATEM_DOLOR action: in _key: null - connector_profile_id: 0f900d50-c16a-11ee-b028-9bf9b00bf3c1 business_model_id: 11f4ee80-c16a-11ee-839d-e5c19a06ccbb business_model_diagram_id: 14890370-c16a-11ee-961e-d7f60c7f0dcd service_task_topic: ET_SIT_DUCIMUS action: eligendi _key: null tags: - Organization post: operationId: postConnectorsApplicationsStore summary: 'Create Connector Application' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Connector Application Response' type: object properties: data: $ref: '#/components/schemas/ConnectorApplicationModel' meta: type: object additionalProperties: true examples: example-0: value: data: connector_profile_id: 152b4ab0-c16a-11ee-8576-35825fce162b business_model_id: 1745e8f0-c16a-11ee-9306-2d2e60622c03 business_model_diagram_id: 197a80d0-c16a-11ee-9e76-476f52c2d4ad service_task_topic: ELIGENDI_AUT_ARCHITECTO action: ea _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: connector_profile_id: type: string description: '' example: iste business_model_id: type: string description: '' example: eaque service_task_topic: type: string description: '' example: necessitatibus action_reference: type: string description: '' example: illum action_config: type: object description: '' example: null properties: [] required: - connector_profile_id - business_model_id - service_task_topic '/api/v2/connectors/applications/{id}': get: operationId: getConnectorsApplicationsShow summary: 'View Connector Application' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Connector Application Response' type: object properties: data: $ref: '#/components/schemas/ConnectorApplicationModel' meta: type: object additionalProperties: true examples: example-0: value: data: connector_profile_id: 1a062940-c16a-11ee-a6c5-ab745d990ce1 business_model_id: 1c26b350-c16a-11ee-a30a-431d62bff9d2 business_model_diagram_id: 1e4ba940-c16a-11ee-832f-cff2e9fe0aea service_task_topic: SUSCIPIT_AUT_APERIAM action: debitis _key: null tags: - Organization put: operationId: putConnectorsApplicationsUpdate summary: 'Update Connector Application' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Connector Application Response' type: object properties: data: $ref: '#/components/schemas/ConnectorApplicationModel' meta: type: object additionalProperties: true examples: example-0: value: data: connector_profile_id: 1ed6bf30-c16a-11ee-af0d-a939ead82544 business_model_id: 20de2820-c16a-11ee-871d-1b4650486879 business_model_diagram_id: 2306dcb0-c16a-11ee-bf1f-55c2467b4b52 service_task_topic: DOLOREMQUE_QUASI_NESCIUNT action: reiciendis _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: connector_profile_id: type: string description: '' example: null business_model_id: type: string description: '' example: null service_task_topic: type: string description: '' example: error action_reference: type: string description: '' example: nemo action_config: type: object description: '' example: null properties: [] delete: operationId: deleteConnectorsApplicationsDestroy summary: 'Delete Connector Application' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Connector Application Response' type: object properties: data: $ref: '#/components/schemas/ConnectorApplicationModel' meta: type: object additionalProperties: true examples: example-0: value: data: connector_profile_id: 23904ef0-c16a-11ee-9c6c-8fd82d8a5e40 business_model_id: 25a08410-c16a-11ee-9851-b9f97bcd826a business_model_diagram_id: 27cadbf0-c16a-11ee-8efb-ff3dfc3ef026 service_task_topic: ENIM_ADIPISCI_HIC action: dolore _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the application.' example: ex required: true schema: type: string /api/v2/connectors/definitions: get: operationId: getConnectorsDefinitionsIndex summary: 'List Connector Definitions' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 403: description: '' content: application/json: schema: type: object example: message: 'Tenant header is missing or is invalid' properties: message: type: string example: 'Tenant header is missing or is invalid' tags: - Organization '/api/v2/users/{user_id}/assign-organization-units': post: operationId: postUsersUsersAssignOrganizationUnits summary: 'Assign Organization Units' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: { } tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: ids: type: array description: '' example: - atque items: type: string parameters: - in: path name: user_id description: 'The ID of the user.' example: 0212d300-8534-11ed-828a-9d6be7cc0d7a required: true schema: type: string '/api/v2/users/{id}': put: operationId: putUsersUsersUpdate summary: Update description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Response' type: object properties: data: $ref: '#/components/schemas/UserModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: Korey surname: Jacobs email: eloy18@example.org phone: '+17656704425' email_verified_at: '1987-04-04T19:13:47.000000Z' _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: organization_ids: type: array description: '' example: null items: type: string organization_unit_ids: type: array description: '' example: null items: type: string name: type: string description: '' example: in surname: type: string description: '' example: assumenda phone: type: string description: '' example: optio delete: operationId: deleteUsersUsersDestroy summary: 'Delete User' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete User Response' type: object properties: data: $ref: '#/components/schemas/UserModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: Mercedes surname: Kessler email: russell.wisoky@example.org phone: +1-938-309-0025 email_verified_at: '1977-01-22T06:46:49.000000Z' _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the user.' example: 0212d300-8534-11ed-828a-9d6be7cc0d7a required: true schema: type: string '/api/v2/users/{user_id}/restore': post: operationId: postUsersUsersRestore summary: 'Restore User' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Restore User Response' type: object properties: data: $ref: '#/components/schemas/UserModel' meta: type: object additionalProperties: true examples: example-0: value: data: name: Myah surname: Denesik email: nbeier@example.org phone: '(904) 698-4669' email_verified_at: '2021-03-17T01:46:35.000000Z' _key: null tags: - Organization parameters: - in: path name: user_id description: 'The ID of the user.' example: 0212d300-8534-11ed-828a-9d6be7cc0d7a required: true schema: type: string /api/v2/forms: get: operationId: getFormsIndex summary: 'List Forms' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Forms Response' type: object properties: data: type: array items: $ref: '#/components/schemas/FormModel' meta: type: object additionalProperties: true examples: example-0: value: data: - organization_id: 524a7f90-c16a-11ee-96d8-8fe5e97a59f2 name: velit layout: [] fields: [] _key: null - organization_id: 52c4a820-c16a-11ee-b5c1-bfac784f1e8c name: itaque layout: [] fields: [] _key: null tags: - Organization post: operationId: postFormsStore summary: 'Create Form' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Create Form Response' type: object properties: data: $ref: '#/components/schemas/FormModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 534443d0-c16a-11ee-900b-775f14e56538 name: nesciunt layout: [] fields: [] _key: null tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: name: type: string description: '' example: consequatur layout: type: object description: '' example: [] properties: [] fields: type: object description: '' example: [] properties: [] required: - name - layout - fields '/api/v2/forms/{id}': get: operationId: getFormsShow summary: 'View Form' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Form Response' type: object properties: data: $ref: '#/components/schemas/FormModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 53c28270-c16a-11ee-a3fd-eb2b1afe8ac2 name: qui layout: [] fields: [] _key: null tags: - Organization put: operationId: putFormsUpdate summary: 'Update Form' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Update Form Response' type: object properties: data: $ref: '#/components/schemas/FormModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 543f8560-c16a-11ee-9c6f-adb6e3fe5a2b name: atque layout: [] fields: [] _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: name: type: string description: '' example: magnam layout: type: object description: '' example: null properties: [] fields: type: object description: '' example: null properties: [] delete: operationId: deleteFormsDestroy summary: 'Delete Form' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Delete Form Response' type: object properties: data: $ref: '#/components/schemas/FormModel' meta: type: object additionalProperties: true examples: example-0: value: data: organization_id: 54bcfc00-c16a-11ee-b8ca-47cec0f0338a name: nihil layout: [] fields: [] _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the form.' example: 1a36dcf0-2c60-11ee-9f3c-a70088ee661c required: true schema: type: string /api/v2/tasks: get: operationId: getTasksIndex summary: 'List Tasks' description: '' parameters: - in: query name: include description: 'List of includes separated by comma.' example: 'reservations,eligible_users,eligible_organization_units' required: false schema: type: string description: 'List of includes separated by comma.' example: 'reservations,eligible_users,eligible_organization_units' - in: query name: 'filter[name]' description: 'List only those tasks that contains specified string in their name.' example: baba required: false schema: type: string description: 'List only those tasks that contains specified string in their name.' example: baba - in: query name: 'filter[eligible]' description: 'List only eligible tasks for current user.' example: true required: false schema: type: boolean description: 'List only eligible tasks for current user.' example: true - in: query name: 'filter[active]' description: 'List only active tasks.' example: true required: false schema: type: boolean description: 'List only active tasks.' example: true - in: query name: 'filter[due]' description: 'List only due tasks.' example: true required: false schema: type: boolean description: 'List only due tasks.' example: true - in: query name: 'filter[due-today]' description: 'List only tasks that will bocome due today.' example: true required: false schema: type: boolean description: 'List only tasks that will bocome due today.' example: true - in: query name: 'filter[process_instance]' description: 'List only specific process instance tasks.' example: 54fffd-445fd-fds55 required: false schema: type: string description: 'List only specific process instance tasks.' example: 54fffd-445fd-fds55 - in: query name: 'filter[engine_definition]' description: 'List tasks by engine task definition.' example: Activity_1n0qsrj required: false schema: type: string description: 'List tasks by engine task definition.' example: Activity_1n0qsrj - in: query name: 'filter[eligible_by_organization_units]' description: 'List only eligible tasks for specified organization units by reference.' example: 'test1,test2' required: false schema: type: string description: 'List only eligible tasks for specified organization units by reference.' example: 'test1,test2' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Tasks Response' type: object properties: data: type: array items: $ref: '#/components/schemas/TaskModel' meta: type: object additionalProperties: true examples: example-0: value: data: - bounty: 10 environment_id: 55b2cb40-c16a-11ee-85c8-6188b740fb6a engine_reference: d0d13f41-23f6-3e77-8d44-628f4ca53113 name: 'Eos optio qui laudantium amet enim. Recusandae eaque quos quo est eligendi in unde eum. Porro harum qui dicta distinctio qui ipsa molestias dicta.' description: 'Caterpillar; and it was over at last, more calmly, though still sobbing a little before she had plenty of time as she spoke. (The unfortunate little Bill had left off writing on his spectacles and.' fields: [] fields_values: null follow_up_at: '2009-07-02T12:52:34.000000Z' due_at: '2011-05-05T20:54:57.000000Z' current_user_active_reservation: null _key: null - bounty: 10 environment_id: 5645de80-c16a-11ee-be3c-45ef5e541318 engine_reference: 31a79990-dadf-3f3f-8e34-c906cd6b1cba name: 'Tempore quis saepe non dolor. Sapiente assumenda id velit similique. Eius molestiae maiores animi rerum earum qui. Qui omnis cum dolorem.' description: 'Duchess: ''what a clear way you go,'' said the King; and the great question is, what did the Dormouse began in a low trembling voice, ''--and I hadn''t to bring tears into her eyes--and still as she.' fields: [] fields_values: null follow_up_at: '1982-03-22T14:11:26.000000Z' due_at: '1995-03-21T17:35:28.000000Z' current_user_active_reservation: null _key: null tags: - Organization '/api/v2/tasks/{id}': get: operationId: getTasksShow summary: 'View Task' description: '' parameters: - in: query name: include description: 'List of includes separated by comma.' example: 'reservations,eligible_users,eligible_organization_units' required: false schema: type: string description: 'List of includes separated by comma.' example: 'reservations,eligible_users,eligible_organization_units' - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Task Response' type: object properties: data: $ref: '#/components/schemas/TaskModel' meta: type: object additionalProperties: true examples: example-0: value: data: bounty: 10 environment_id: 56c5e330-c16a-11ee-9d46-71677ae06f6f engine_reference: cef7ef41-2be4-3508-a540-0d747280127d name: 'Consequatur quae et minus corrupti asperiores. Vel dolor hic itaque ut nesciunt alias.' description: 'I think I could, if I shall never get to the beginning again?'' Alice ventured to say. ''What is his sorrow?'' she asked the Gryphon, and the other two were using it as to bring tears into her eyes.' fields: [] fields_values: null follow_up_at: '1987-07-25T03:27:25.000000Z' due_at: '1995-05-18T22:26:49.000000Z' current_user_active_reservation: null _key: null tags: - Organization parameters: - in: path name: id description: 'The ID of the task.' example: rerum required: true schema: type: string '/api/v2/tasks/{task_id}/reservation': post: operationId: postTasksReserve summary: 'Reserve Task' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Reserve Task Response' type: object properties: data: $ref: '#/components/schemas/TaskModel' meta: type: object additionalProperties: true examples: example-0: value: data: bounty: 10 environment_id: 57403c80-c16a-11ee-b660-637ee87982d1 engine_reference: d2377ac2-7d15-3314-ae72-cf2fef2adebe name: 'Quia quidem in dolores labore eveniet. Est nam nisi officiis et. Velit officiis voluptates ipsa soluta non cumque quo aut. Autem similique nulla odio incidunt hic delectus.' description: 'KNOW IT TO BE TRUE--" that''s the jury, of course--"I GAVE HER ONE, THEY GAVE HIM TWO--" why, that must be what he did with the strange creatures of her head struck against the roof of the hall: in.' fields: [] fields_values: null follow_up_at: '2010-07-27T11:10:26.000000Z' due_at: '2001-10-20T04:11:10.000000Z' current_user_active_reservation: null _key: null tags: - Organization delete: operationId: deleteTasksUnreserve summary: 'Unreserve Task' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Unreserve Task Response' type: object properties: data: $ref: '#/components/schemas/TaskModel' meta: type: object additionalProperties: true examples: example-0: value: data: bounty: 10 environment_id: 57bf4770-c16a-11ee-b6ed-7da24f033e14 engine_reference: 1e3f45a5-4080-3ff6-b627-298f854fce13 name: 'Dolore fugit natus minima eum. Ea aut expedita ut est velit architecto aut. Consequuntur quia libero occaecati non dolores.' description: 'She had quite forgotten the Duchess sang the second time round, she found she had caught the baby violently up and walking off to the Mock Turtle. ''She can''t explain it,'' said the cook. The King.' fields: [] fields_values: null follow_up_at: '1977-10-26T20:38:33.000000Z' due_at: '1983-08-16T00:06:03.000000Z' current_user_active_reservation: null _key: null tags: - Organization parameters: - in: path name: task_id description: 'The ID of the task.' example: autem required: true schema: type: string '/api/v2/tasks/{task_id}/complete': post: operationId: postTasksComplete summary: 'Complete Task' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Complete Task Response' type: object properties: data: $ref: '#/components/schemas/TaskModel' meta: type: object additionalProperties: true examples: example-0: value: data: bounty: 10 environment_id: 583d3ae0-c16a-11ee-9d30-7116a303fad7 engine_reference: a9e10d62-3465-3cae-9ad5-c6ce35bf437e name: 'Ducimus nam non rem quia iure illo minus. Unde perferendis aut aliquam est facilis nihil excepturi. Odit ut placeat ipsa assumenda incidunt.' description: 'The master was an old Turtle--we used to say it over) ''--yes, that''s about the games now.'' CHAPTER X. The Lobster Quadrille is!'' ''No, indeed,'' said Alice. ''Why?'' ''IT DOES THE BOOTS AND SHOES.'' the.' fields: [] fields_values: null follow_up_at: '1996-11-04T08:33:43.000000Z' due_at: '1982-07-28T13:31:02.000000Z' current_user_active_reservation: null _key: null tags: - Organization requestBody: required: false content: application/json: schema: type: object properties: submission: type: array description: '' example: null items: type: string parameters: - in: path name: task_id description: 'The ID of the task.' example: consectetur required: true schema: type: string /api/v2/analyses: get: operationId: getAnalysesIndex summary: 'List Analyses' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 403: description: '' content: application/json: schema: type: object example: message: 'Tenant header is missing or is invalid' properties: message: type: string example: 'Tenant header is missing or is invalid' tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: references: type: array description: '' example: - neque items: type: string time_range_start: type: string description: 'Must be a valid date.' example: '2024-02-02T01:28:18' time_range_end: type: string description: 'Must be a valid date.' example: '2024-02-02T01:28:18' required: - references /api/v2/summaries: get: operationId: getSummariesIndex summary: 'List Analyses' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 403: description: '' content: application/json: schema: type: object example: message: 'Tenant header is missing or is invalid' properties: message: type: string example: 'Tenant header is missing or is invalid' tags: - Organization requestBody: required: true content: application/json: schema: type: object properties: references: type: array description: '' example: - sint items: type: string time_range_start: type: string description: 'Must be a valid date.' example: '2024-02-02T01:28:18' time_range_end: type: string description: 'Must be a valid date.' example: '2024-02-02T01:28:18' required: - references '/api/v2/environment/{environment_id}/business-process-instances': get: operationId: getBusinessProcessInstancesIndex summary: 'List Business Process Instances' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Business Process Instances Response' type: object properties: data: type: array items: $ref: '#/components/schemas/BusinessProcessInstanceType' meta: type: object additionalProperties: true examples: example-0: value: data: - reference: dolore startedAt: 1983-08-25T10:48:27+00:00 endedAt: 1977-01-22T04:24:06+00:00 publication: business_model_diagram_id: 29fc0530-c16a-11ee-90e2-91782c57d6b1 engine_deployment_reference: df571db3-345a-3a68-a930-928a6c49fb4c engine_diagram_reference: 6ba38f9d-8a24-38e9-a211-517721965701 engine_model_reference: Process_QuiaEstEt. context: id attributes: [] - reference: dolorem startedAt: 2022-12-29T08:12:33+00:00 endedAt: 1982-07-13T23:17:53+00:00 publication: business_model_diagram_id: 2c5de320-c16a-11ee-ba40-ff11e98e5c68 engine_deployment_reference: 25ee6683-62cb-3e34-915e-4d74ab40ed88 engine_diagram_reference: fa250f11-cc89-3cc1-ada4-cb2af4170b11 engine_model_reference: Process_QuidemUllam. context: quis attributes: [] tags: - Environment requestBody: required: false content: application/json: schema: type: object properties: activities: type: array description: '' example: - ad items: type: string active_only: type: boolean description: '' example: true sort_by: type: string description: '' example: repellat sort_order: type: string description: 'Must be one of asc or desc.' example: desc page: type: object description: '' example: null properties: number: type: integer description: '' example: 18 size: type: integer description: '' example: 10 publication_engine_diagram_reference: type: string description: '' example: quasi publication_engine_model_reference: type: string description: '' example: aperiam publication_engine_deployment_reference: type: string description: '' example: quod parameters: - in: path name: environment_id description: 'The ID of the environment.' example: blanditiis required: true schema: type: string '/api/v2/environment/{environment_id}/business-process-instances/{id}': get: operationId: getBusinessProcessInstancesShow summary: 'View Business Process Instance' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Process Instance Response' type: object properties: data: $ref: '#/components/schemas/BusinessProcessInstanceType' meta: type: object additionalProperties: true examples: example-0: value: data: reference: quia startedAt: 2003-02-04T03:32:16+00:00 endedAt: 1985-07-15T07:51:36+00:00 publication: business_model_diagram_id: 2e855640-c16a-11ee-a9a7-17e1472d2087 engine_deployment_reference: cd197594-d1c6-3d2b-b12d-6c3a28c5071a engine_diagram_reference: b02f9117-f1a6-3291-8601-464068f94a7d engine_model_reference: Process_MagniMinima. context: harum attributes: [] tags: - Environment parameters: - in: path name: environment_id description: 'The ID of the environment.' example: et required: true schema: type: string - in: path name: id description: 'The ID of the business process instance.' example: quo required: true schema: type: string '/api/v2/environment/{environment_id}/business-activity-instances': get: operationId: getBusinessActivityInstancesIndex summary: 'List Business Activity Instances' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Business Activity Instances Response' type: object properties: data: type: array items: $ref: '#/components/schemas/BusinessActivityInstanceType' meta: type: object additionalProperties: true examples: example-0: value: data: - reference: omnis name: sit type: tempora startedAt: 2014-09-03T20:36:20+00:00 endedAt: 1984-01-14T03:32:47+00:00 processInstance: reference: recusandae startedAt: 1977-10-01T04:39:37+00:00 endedAt: 1988-02-01T13:29:56+00:00 publication: business_model_diagram_id: 30a58c60-c16a-11ee-a96e-f55da3976208 engine_deployment_reference: 9f8b38da-90be-3da2-b09e-a938b083d77b engine_diagram_reference: ac8d9f0e-a138-34fb-a8ce-66aeb92c28bb engine_model_reference: Process_Voluptatibus. context: voluptas attributes: [] - reference: nihil name: doloribus type: non startedAt: 1985-10-14T07:55:12+00:00 endedAt: 1977-01-14T22:33:53+00:00 processInstance: reference: temporibus startedAt: 1975-09-20T04:37:38+00:00 endedAt: 1991-02-19T05:54:21+00:00 publication: business_model_diagram_id: 32b760a0-c16a-11ee-8828-f98cfb91142f engine_deployment_reference: c2ca05cf-0ae4-32f1-be2b-82bde5227aba engine_diagram_reference: b2e221b0-fbd8-3fc5-b1df-0a35ef6a1886 engine_model_reference: Process_UtExplicabo. context: repudiandae attributes: [] tags: - Environment requestBody: required: false content: application/json: schema: type: object properties: activity_reference: type: string description: '' example: architecto processed: type: boolean description: '' example: false sort_by: type: string description: '' example: est sort_order: type: string description: 'Must be one of asc or desc.' example: desc page: type: object description: '' example: null properties: number: type: integer description: '' example: 2 size: type: integer description: '' example: 12 diagram_engine_reference: type: string description: '' example: sed process_instance_reference: type: string description: '' example: eaque parameters: - in: path name: environment_id description: 'The ID of the environment.' example: dignissimos required: true schema: type: string '/api/v2/environment/{environment_id}/business-activity-instances/{id}': get: operationId: getBusinessActivityInstancesShow summary: 'View Business Activity Instance' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'View Business Activity Instance Response' type: object properties: data: $ref: '#/components/schemas/BusinessActivityInstanceType' meta: type: object additionalProperties: true examples: example-0: value: data: reference: consequatur name: est type: nesciunt startedAt: 1992-01-01T14:33:02+00:00 endedAt: 1997-04-21T04:45:38+00:00 processInstance: reference: est startedAt: 2018-05-10T08:38:56+00:00 endedAt: 2009-08-02T11:44:39+00:00 publication: business_model_diagram_id: 34d21950-c16a-11ee-8377-999830aa47f9 engine_deployment_reference: d9678a42-f15e-3ba2-8ec5-b4ba26cdc9b2 engine_diagram_reference: c85d2fa4-8743-35a5-93e3-5f5f91209e82 engine_model_reference: Process_AutemIpsam. context: hic attributes: [] tags: - Environment parameters: - in: path name: environment_id description: 'The ID of the environment.' example: aut required: true schema: type: string - in: path name: id description: 'The ID of the business activity instance.' example: pariatur required: true schema: type: string '/api/v2/environment/{environment_id}/events/{reference}/send-message': post: operationId: postEventSendMessage summary: '' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: { } tags: - Environment parameters: - in: path name: environment_id description: 'The ID of the environment.' example: est required: true schema: type: string - in: path name: reference description: '' example: ipsam required: true schema: type: string '/api/v2/environment/{environment_id}/events/{reference}/send-signal': post: operationId: postEventSendSignal summary: '' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: { } tags: - Environment parameters: - in: path name: environment_id description: 'The ID of the environment.' example: eveniet required: true schema: type: string - in: path name: reference description: '' example: molestiae required: true schema: type: string '/api/v2/environment/{environment_id}/service-tasks': get: operationId: getServiceTaskIndex summary: 'List Service Tasks' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'List Service Tasks Response' type: object properties: data: type: array items: $ref: '#/components/schemas/ServiceTaskType' meta: type: object additionalProperties: true examples: example-0: value: data: - reference: id topic: excepturi suspended: false priority: 798803917 environment: engine_id: 3556b160-c16a-11ee-8cf9-2963f09ea677 engine_reference: 3c09208e-1715-3f13-912d-e239d814c530 production: false name: unde auth_token: f9596ca7-d3ba-3905-b5ac-9ce1225ef7b3 activity: name: exercitationem reference: quasi instance: reference: voluptatem startedAt: 2019-02-04T20:12:47+00:00 endedAt: 1970-12-30T19:13:04+00:00 publication: business_model_diagram_id: 377987f0-c16a-11ee-b554-e5007547dd07 engine_deployment_reference: 3ef496e4-6d0a-3769-8942-0890d001dbb8 engine_diagram_reference: af2c34b5-0e0c-3158-9b91-0248d87e0b44 engine_model_reference: Process_IustoAccusantium. context: quaerat attributes: [] attributes: [] - reference: natus topic: optio suspended: false priority: 39931 environment: engine_id: 38042fd0-c16a-11ee-bad3-2badfb06e9b5 engine_reference: 2da6f49c-4a3c-3659-8897-8cd5b49e015f production: false name: voluptas auth_token: a53bea65-eaea-3056-8ba9-7d37cc6de826 activity: name: atque reference: veniam instance: reference: officiis startedAt: 2014-05-16T15:47:27+00:00 endedAt: 1979-03-04T11:32:36+00:00 publication: business_model_diagram_id: 3a49a1f0-c16a-11ee-9f3d-273e0a8c0aab engine_deployment_reference: 285b6d43-891e-3570-8980-8492a477fd70 engine_diagram_reference: f4ac9010-4b90-317e-8899-1f2336d9e805 engine_model_reference: Process_EosBeataeEt. context: voluptas attributes: [] attributes: [] tags: - Environment requestBody: required: false content: application/json: schema: type: object properties: topic: type: string description: '' example: consequatur activities: type: array description: '' example: - aspernatur items: type: string active_only: type: boolean description: '' example: true sort_by: type: string description: '' example: et sort_order: type: string description: 'Must be one of asc or desc.' example: asc page: type: object description: '' example: null properties: number: type: integer description: '' example: 1 size: type: integer description: '' example: 13 process_instance_references: type: array description: '' example: - fuga items: type: string publication_engine_diagram_reference: type: string description: '' example: delectus publication_engine_model_reference: type: string description: '' example: omnis parameters: - in: path name: environment_id description: 'The ID of the environment.' example: consequatur required: true schema: type: string '/api/v2/environment/{environment_id}/service-tasks/{reference}/lock': post: operationId: postServiceTaskLock summary: 'Lock a Service Task' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Lock a Service Task Response' type: object properties: data: $ref: '#/components/schemas/ServiceTaskType' meta: type: object additionalProperties: true examples: example-0: value: data: reference: vel topic: maiores suspended: true priority: 780403949 environment: engine_id: 3ad664d0-c16a-11ee-922e-8fcf7dd4f5e1 engine_reference: e6ceeb91-3ef3-3b32-975b-f4dae1925848 production: false name: sed auth_token: a9fcd589-b742-3fee-8642-50ef7f98de24 activity: name: illo reference: ipsa instance: reference: voluptatibus startedAt: 1972-08-11T08:50:05+00:00 endedAt: 1990-03-06T19:12:23+00:00 publication: business_model_diagram_id: 3ce4fec0-c16a-11ee-a917-8b1f5de2a494 engine_deployment_reference: 1b1e7d01-e556-3103-9b05-187f0b104f79 engine_diagram_reference: 281efa80-0a3a-30cf-abdf-943dc4df0de8 engine_model_reference: Process_VoluptasQuisAut. context: quis attributes: [] attributes: [] tags: - Environment parameters: - in: path name: environment_id description: 'The ID of the environment.' example: quibusdam required: true schema: type: string - in: path name: reference description: '' example: voluptate required: true schema: type: string '/api/v2/environment/{environment_id}/service-tasks/{reference}/unlock': post: operationId: postServiceTaskUnlock summary: 'Unlock a Service Task' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Unlock a Service Task Response' type: object properties: data: $ref: '#/components/schemas/ServiceTaskType' meta: type: object additionalProperties: true examples: example-0: value: data: reference: tenetur topic: similique suspended: false priority: 8951637 environment: engine_id: 3d669010-c16a-11ee-b779-3b1391a7d995 engine_reference: 5acc470c-3704-3232-b5d9-58ef5255ee9f production: false name: qui auth_token: bd96175d-17f4-33a0-a146-3d54d052a95b activity: name: harum reference: delectus instance: reference: maiores startedAt: 1975-10-25T20:43:52+00:00 endedAt: 1970-07-24T08:30:43+00:00 publication: business_model_diagram_id: 3f745aa0-c16a-11ee-a490-f3baaec8ffe7 engine_deployment_reference: e6170143-8d1c-364e-84e6-455ae2ad9c63 engine_diagram_reference: 4136fad8-8351-3101-b8b8-0e6252b9c7d5 engine_model_reference: Process_VelNisiQuasiAut. context: dolore attributes: [] attributes: [] tags: - Environment parameters: - in: path name: environment_id description: 'The ID of the environment.' example: officiis required: true schema: type: string - in: path name: reference description: '' example: possimus required: true schema: type: string '/api/v2/environment/{environment_id}/service-tasks/{reference}/serve': post: operationId: postServiceTaskServe summary: 'Serve a Service Task' description: '' parameters: - in: header name: X-Tenant description: '' example: xxxxx-xxxx-xxxxxxxxxxxxxxxxxx schema: type: string responses: 200: description: '' content: application/json: schema: title: 'Serve a Service Task Response' type: object properties: data: $ref: '#/components/schemas/ServiceTaskType' meta: type: object additionalProperties: true examples: example-0: value: data: reference: et topic: nobis suspended: false priority: 70 environment: engine_id: 400bb170-c16a-11ee-935e-97405198a454 engine_reference: dc21c2d1-1b4e-3c0e-bc32-1ae953a51ee0 production: true name: ea auth_token: 326eef64-ce13-3a9c-a732-a331ef2a215e activity: name: aut reference: ut instance: reference: facilis startedAt: 1984-03-06T04:17:36+00:00 endedAt: 2014-11-11T07:00:13+00:00 publication: business_model_diagram_id: 4204d640-c16a-11ee-a8b3-75fdbb7aab52 engine_deployment_reference: 2db75df6-f033-37f8-968e-d61cce8b4f4d engine_diagram_reference: c52231f5-cbcb-3ae2-b381-74a4a6aee2fc engine_model_reference: Process_AutMollitia. context: non attributes: [] attributes: [] tags: - Environment requestBody: required: true content: application/json: schema: type: object properties: submission: type: array description: '' example: - assumenda items: type: string required: - submission parameters: - in: path name: environment_id description: 'The ID of the environment.' example: possimus required: true schema: type: string - in: path name: reference description: '' example: nulla required: true schema: type: string tags: - name: User description: '' - name: Open description: '' - name: Organization description: '' - name: Environment description: '' components: securitySchemes: default: type: http scheme: bearer description: '' schemas: UserModel: type: object properties: name: type: string surname: type: string email: type: string phone: type: string email_verified_at: type: string password: type: string remember_token: type: string OrganizationUnitModel: type: object properties: organization_id: type: string name: type: string description: type: string parent_id: type: string parent: $ref: '#/components/schemas/OrganizationUnitModel' OrganizationModel: type: object properties: name: type: string country: type: string company_code: type: string city: type: string address: type: string vat: type: string WorldCountryModel: type: object properties: iso2: type: string name: type: string status: type: integer phone_code: type: integer iso3: type: string region: type: string subregion: type: string WorldStateModel: type: object properties: country_id: type: integer name: type: string country_code: type: string WorldCityModel: type: object properties: country_id: type: integer state_id: type: integer name: type: string country_code: type: string WorldTimezoneModel: type: object properties: country_id: type: integer name: type: string WorldCurrencyModel: type: object properties: country_id: type: integer name: type: string code: type: string precision: type: integer symbol: type: string symbol_native: type: string symbol_first: type: string decimal_mark: type: string thousands_separator: type: string WorldLanguageModel: type: object properties: code: type: string name: type: string name_native: type: string dir: type: string BusinessBaseModelModel: type: object properties: owner_id: type: string organization_id: type: string category_id: type: integer business_process_id: type: integer name: type: string _lft: type: integer _rgt: type: integer summary: type: string type: type: string DataPointCollection: type: object BusinessProcessModelDiagramModel: type: object properties: business_model_id: type: string xml: type: string version: type: integer SubscriptionType: type: object properties: id: type: string createdAt: type: integer startAt: type: integer currentPeriodEndAt: type: integer latestInvoiceId: type: string status: type: string name: type: string PaymentType: type: object properties: id: type: string amountPaid: type: integer pdf: type: string paidAt: type: integer status: type: string subscriptionId: type: string total: type: integer EnvironmentModel: type: object properties: engine_id: type: string engine_reference: type: string production: type: boolean name: type: string auth_token: type: string CategoryModel: type: object properties: organization_id: type: string slug: type: string name: type: string description: type: string _lft: type: integer _rgt: type: integer parent_id: type: integer parent: $ref: '#/components/schemas/CategoryModel' EngineModel: type: object properties: organization_id: type: string name: type: string bridge: type: string path: type: string auth: type: string production: type: boolean shared: type: boolean TagModel: type: object properties: name: type: string InvitationModel: type: object properties: organization_id: type: string email: type: string type: type: string user_id: type: string expired_at: type: string BusinessBaseModelDiagramModel: type: object properties: business_model_id: type: string xml: type: string version: type: integer CommentModel: type: object properties: parent_id: type: integer commentable_id: type: string commenter_id: type: string commentable_type: type: string comment: type: string status: type: integer BusinessBaseModelPublicationModel: type: object properties: business_model_diagram_id: type: string engine_deployment_reference: type: string engine_diagram_reference: type: string engine_model_reference: type: string BusinessBaseModelExceptionModel: type: object properties: organization_id: type: string source: type: string solution: type: string consequences: type: string incidence: type: string impact: type: string causative_organization_unit_id: type: string responsible_organization_unit_id: type: string ConnectorProfileModel: type: object properties: organization_id: type: string label: type: string name: type: string version: type: string config: type: string ConnectorApplicationModel: type: object properties: connector_profile_id: type: string business_model_id: type: string business_model_diagram_id: type: string service_task_topic: type: string action: type: string FormModel: type: object properties: organization_id: type: string name: type: string layout: type: string fields: type: string TaskModel: type: object properties: bounty: type: integer environment_id: type: string engine_reference: type: string name: type: string description: type: string fields: type: string follow_up_at: type: string due_at: type: string DateTime: type: object BusinessProcessModelPublication: type: object DataAttributeType: type: object properties: reference: type: string engineReference: type: string type: type: string label: type: string defaultValue: { } DataPointType: type: object properties: attribute: $ref: '#/components/schemas/DataAttributeType' value: { } BusinessProcessInstanceType: type: object properties: reference: type: string startedAt: $ref: '#/components/schemas/DateTime' endedAt: $ref: '#/components/schemas/DateTime' publication: $ref: '#/components/schemas/BusinessProcessModelPublication' context: type: string attributes: type: object additionalProperties: $ref: '#/components/schemas/DataPointType' BusinessActivityInstanceType: type: object properties: reference: type: string name: type: string type: type: string startedAt: $ref: '#/components/schemas/DateTime' endedAt: $ref: '#/components/schemas/DateTime' processInstance: $ref: '#/components/schemas/BusinessProcessInstanceType' Environment: type: object ActivityType: type: object properties: name: type: string reference: type: string ServiceTaskType: type: object properties: reference: type: string topic: type: string suspended: type: boolean priority: type: integer environment: $ref: '#/components/schemas/Environment' activity: $ref: '#/components/schemas/ActivityType' instance: $ref: '#/components/schemas/BusinessProcessInstanceType' attributes: type: object additionalProperties: $ref: '#/components/schemas/DataPointType' security: - default: []