{ "openapi": "3.0.0", "info": { "title": "Heimdall portal component", "description": "Heimdall provide all informations about services, contracts, users and here relations", "version": "dev" }, "paths": { "\/api\/area": { "get": { "tags": [ "areas" ], "description": "Get all areas", "operationId": "get_app_area_getallareas", "parameters": [ { "name": "areaMetadatas[key][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "areaMetadatas[value][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all areas" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "areas" ], "description": "Create area", "operationId": "post_app_area_createarea", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Area2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/area": { "get": { "tags": [ "areas" ], "description": "Get all area by contract", "operationId": "get_app_area_getallareabycontract", "parameters": [ { "name": "areaMetadatas[key][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "areaMetadatas[value][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all area by contract" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/client\/{clientId}\/area": { "get": { "tags": [ "areas" ], "description": "Get all area by client", "operationId": "get_app_area_getallareabyclient", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "labelFilter", "in": "query", "description": "Filter on area label name", "required": false, "schema": { "type": "string" } }, { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all area by client" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/area\/{areaId}": { "get": { "tags": [ "areas" ], "description": "Get one area by id", "operationId": "get_app_area_getareabyid", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One area", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Area" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "areas" ], "description": "Update one area by id", "operationId": "put_app_area_updateareabyid", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Area3" } } } }, "responses": { "204": { "description": "area is updated" } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "areas" ], "description": "Delete one area by id", "operationId": "delete_app_area_deletearea", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "One area deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}\/area": { "get": { "tags": [ "areas" ], "description": "Get all area by organization", "operationId": "get_app_area_getallareabyorganization", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all area by organization" } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "organization" ], "description": "Add area to organization", "operationId": "put_app_organization_addorganizationarea", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Area4" } } } }, "responses": { "200": { "description": "Ok" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/area": { "get": { "tags": [ "areas" ], "description": "Get all area by user", "operationId": "get_app_area_getuserareas", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all area by organization" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/area\/{areaId}\/areaMetadata": { "get": { "tags": [ "areaMetadata" ], "description": "Get all areaMetadatas by area", "operationId": "get_app_areametadata_getallareametadatasbyarea", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all areaMetadatas" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "areaMetadata" ], "description": "add meta data to area", "operationId": "post_app_areametadata_addareametadatastoarea", "parameters": [ { "name": "areaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AreaMetadata2" } } } }, "responses": { "201": { "description": "Return the area matadata link in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/areaType": { "get": { "tags": [ "areaTypes" ], "description": "Get all areaTypes", "operationId": "get_app_areatype_getallareatypes", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all areaTypes" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "areaTypes" ], "description": "Create areaType", "operationId": "post_app_areatype_createareatype", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AreaType2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/areaType\/{areaTypeId}": { "get": { "tags": [ "areaTypes" ], "description": "Get on areaType by id", "operationId": "get_app_areatype_getareatypebyid", "parameters": [ { "name": "areaTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One areaType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AreaType" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "areaTypes" ], "description": "Update on areaType by id", "operationId": "put_app_areatype_updateareatypebyid", "parameters": [ { "name": "areaTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/AreaType3" } } } }, "responses": { "204": { "description": "AreaType is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/category": { "get": { "tags": [ "category" ], "description": "Get all categories", "operationId": "get_get_all_category", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "externalId", "in": "query", "description": "search externalId in categories to filter results", "required": false, "schema": { "type": "string" } }, { "name": "categoryType", "in": "query", "description": "search categoryType in categories to filter results", "required": false, "schema": { "type": "string" } }, { "name": "showAll", "in": "query", "description": "if true, also display Categories set as inactive", "required": false, "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "Categories list" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "category" ], "description": "Create one category", "operationId": "post_create_category", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Category2" } } } }, "responses": { "201": { "description": "Category created", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Category" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/category\/{categoryId}": { "get": { "tags": [ "category" ], "description": "Get category by id", "operationId": "get_get_category_by_id", "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Categories list", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Category" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/category\/{categoryId}\/category": { "get": { "tags": [ "category" ], "description": "Get children category by id", "operationId": "get_get_children_category_by_id", "parameters": [ { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Categories list" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/area\/{areaId}\/category": { "get": { "tags": [ "category" ], "description": "Get categories by area", "operationId": "get_get_category_by_area", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "areaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Categories by area", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Category" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/client": { "get": { "tags": [ "clients" ], "description": "Get all clients", "operationId": "get_app_client_getallclient", "parameters": [ { "name": "q", "in": "query", "description": "filter client by label", "required": false, "schema": { "type": "string" } }, { "name": "clientMetadatas[key][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "clientMetadatas[value][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all clients" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "clients" ], "description": "Create client", "operationId": "post_app_client_createclient", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Client2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/client\/{clientId}": { "get": { "tags": [ "clients" ], "description": "Get on client by id", "operationId": "get_app_client_getclientbyid", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One client", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Client" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "clients" ], "description": "Update on client by id", "operationId": "put_app_client_updateclientbyid", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Client3" } } } }, "responses": { "204": { "description": "Client is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/client\/{clientId}\/clientMetadata": { "get": { "tags": [ "clientMetadata" ], "description": "Get all clientMetadatas by client", "operationId": "get_app_clientmetadata_getallclientmetadatasbyclient", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all clientMetadatas" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "clientMetadata" ], "description": "add meta data to client", "operationId": "post_app_clientmetadata_addclientmetadatastoclient", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ClientMetadata2" } } } }, "responses": { "201": { "description": "Return the client matadata link in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/clientType": { "get": { "tags": [ "clientTypes" ], "description": "Get all clientTypes", "operationId": "get_app_clienttype_getallclienttypes", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all clientTypes" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "clientTypes" ], "description": "Create clientType", "operationId": "post_app_clienttype_createclienttype", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ClientType2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/clientType\/{clientTypeId}": { "get": { "tags": [ "clientTypes" ], "description": "Get on clientType by id", "operationId": "get_app_clienttype_getclienttypebyid", "parameters": [ { "name": "clientTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One clientType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ClientType" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "clientTypes" ], "description": "Update on clientType by id", "operationId": "put_app_clienttype_updateclienttypebyid", "parameters": [ { "name": "clientTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ClientType3" } } } }, "responses": { "204": { "description": "ClientType is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contractArea": { "get": { "tags": [ "contractAreas" ], "description": "Get all contractAreas", "operationId": "get_app_contractarea_getallcontractareas", "parameters": [ { "name": "q", "in": "query", "description": "search q in contractArea to filter results", "required": false, "schema": { "type": "string" } }, { "name": "areaId", "in": "query", "description": "search areaId in contractArea to filter results", "required": false, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all contractAreas" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "contractAreas" ], "description": "Create contractArea", "operationId": "post_app_contractarea_createcontractarea", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractArea2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/contractArea": { "get": { "tags": [ "contractAreas" ], "description": "Get all contractArea by contract", "operationId": "get_app_contractarea_getallcontractareabycontract", "parameters": [ { "name": "q", "in": "query", "description": "search q in contractArea to filter results", "required": false, "schema": { "type": "string" } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all contractArea by contract" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contractArea\/{contractAreaId}": { "get": { "tags": [ "contractAreas" ], "description": "Get one contractArea by id", "operationId": "get_app_contractarea_getcontractareabyid", "parameters": [ { "name": "contractAreaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One contractArea", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractArea" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "contractAreas" ], "description": "Update one contractArea by id", "operationId": "put_app_contractarea_updatecontractareabyid", "parameters": [ { "name": "contractAreaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractArea3" } } } }, "responses": { "204": { "description": "contractArea is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract": { "get": { "tags": [ "contracts" ], "description": "Get all contracts", "operationId": "get_app_contract_getallcontracts", "parameters": [ { "name": "q", "in": "query", "description": "search q in contract to filter results", "required": false, "schema": { "type": "string" } }, { "name": "client", "in": "query", "description": "id of the client to filter results", "required": false, "schema": { "type": "string" } }, { "name": "contractMetadatas[key][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contractMetadatas[value][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contractMetadatasSearchMode", "in": "query", "description": "which mode to use (strict or non-strict), strict for searching the exact giving value, and non-strict to if the contractMetadata contains the giving value", "required": false, "schema": { "type": "string", "default": "strict", "enum": [ "strict", "non-strict" ] } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all contracts" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "contracts" ], "description": "Create contract", "operationId": "post_app_contract_createcontract", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Contract2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}": { "get": { "tags": [ "contracts" ], "description": "Get on contract by id", "operationId": "get_app_contract_getcontractbyid", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One contract", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Contract" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "contracts" ], "description": "Update on contract by id", "operationId": "put_app_contract_updatecontractbyid", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Contract3" } } } }, "responses": { "204": { "description": "Contract is updated" } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "contracts" ], "description": "Delete contract by id", "operationId": "delete_app_contract_deletecontractbyid", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Contract is deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/client\/{clientId}\/contract": { "get": { "tags": [ "contracts" ], "description": "Get all contract by client by id", "operationId": "get_app_contract_getcontractbyclient", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all contracts for this client" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/contract": { "get": { "tags": [ "contracts" ], "description": "Get all contract activated for user", "operationId": "get_app_contract_getcontractbyuser", "parameters": [ { "name": "q", "in": "query", "description": "search q in contract to filter results", "required": false, "schema": { "type": "string" } }, { "name": "contractMetadatas[key][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contractMetadatas[value][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "contractMetadatasSearchMode", "in": "query", "description": "which mode to use (strict or non-strict), strict for searching the exact giving value, and non-strict to if the contractMetadata contains the giving value", "required": false, "schema": { "type": "string", "default": "strict", "enum": [ "strict", "non-strict" ] } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "withProfiles", "in": "query", "description": "whether or not to includes contracts from UserProfile (e.g : those on which user has AdminRights)", "required": false, "schema": { "type": "boolean", "default": "false" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all contracts for this user" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/contractMetadata": { "get": { "tags": [ "contractMetadata" ], "description": "Get all contractMetadatas by contract", "operationId": "get_app_contractmetadata_getallcontractmetadatasbycontract", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all contractMetadatas" } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "contractMetadata" ], "description": "add meta data to contract", "operationId": "put_app_contractmetadata_updatecontractmetadatas", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractMetadata2" } } } }, "responses": { "201": { "description": "Return the contract matadata link in 'location' header" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "contractMetadata" ], "description": "add meta data to contract", "operationId": "post_app_contractmetadata_addcontractmetadatas", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractMetadata2" } } } }, "responses": { "201": { "description": "Return the contract matadata link in 'location' header" } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "contractMetadata" ], "description": "delete metadata to contract", "operationId": "delete_app_contractmetadata_deletecontractmetadata", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractMetadata2" } } } }, "responses": { "204": { "description": "Return always 204 same if metadata already delete" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contractService": { "get": { "tags": [ "contractServices" ], "description": "Get all contract services", "operationId": "get_app_contractservice_getallcontractservices", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all contract services" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "contractServices" ], "description": "Create contract service", "operationId": "post_app_contractservice_createcontractservice", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractService2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contractService\/{contractServiceId}": { "get": { "tags": [ "contractServices" ], "description": "Get one contract service by id", "operationId": "get_app_contractservice_getcontractservicebyid", "parameters": [ { "name": "contractServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One contract service", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractService" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "contractServices" ], "description": "Update a contract service by id", "operationId": "put_app_contractservice_updatecontractservicebyid", "parameters": [ { "name": "contractServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractService3" } } } }, "responses": { "204": { "description": "Contract service is updated" } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "contractServices" ], "description": "Delete one contract service by id", "operationId": "delete_app_contractservice_deletecontractservicebyid", "parameters": [ { "name": "contractServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "One contract service deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/contractService": { "get": { "tags": [ "contractServices" ], "description": "Get all contract service of a contract", "operationId": "get_app_contractservice_getcontractservicebycontract", "parameters": [ { "name": "category[]", "in": "query", "description": "filter by service having one of the given categories", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "noCategory", "in": "query", "description": "depending on if category parameter is used, filter IN or OUT the services that have no category", "required": false, "schema": { "type": "boolean" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "serviceLabel", "in": "query", "description": "Filter on service that contains matching label", "required": false, "schema": { "type": "string" } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all contract services for this contract" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/service\/{serviceCode}\/contractService": { "get": { "tags": [ "contractServices" ], "description": "Get all contract service of a service", "operationId": "get_app_contractservice_getcontractservicebyservice", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "serviceCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all contract services for this service" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contractServiceOption": { "get": { "tags": [ "contractServiceOptions" ], "description": "Get all contract services", "operationId": "get_app_contractserviceoption_getallcontractserviceoptions", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all contract services" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "contractServiceOptions" ], "description": "Create contract service", "operationId": "post_app_contractserviceoption_createcontractserviceoption", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractServiceOption2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contractServiceOption\/{contractServiceOptionId}": { "get": { "tags": [ "contractServiceOptions" ], "description": "Get one contract service by id", "operationId": "get_app_contractserviceoption_getcontractserviceoptionbyid", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "contractServiceOptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One contract service", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractServiceOption3" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "contractServiceOptions" ], "description": "Update a contract service by id", "operationId": "put_app_contractserviceoption_updatecontractserviceoptionbyid", "parameters": [ { "name": "contractServiceOptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ContractServiceOption4" } } } }, "responses": { "204": { "description": "Contract service is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contractService\/{contractServiceId}\/contractServiceOption": { "get": { "tags": [ "contractServiceOptions" ], "description": "Get all contract service of a contract", "operationId": "get_app_contractserviceoption_getcontractserviceoptionbycontractservice", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "contractServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all contract services for this contract" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/contractServiceOption": { "get": { "tags": [ "contractServiceOptions" ], "description": "Get all contractServiceOptions of a contract", "operationId": "get_app_contractserviceoption_getallcontractserviceoptionsbycontract", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all contractServiceOptions of this contract" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/legalEntity": { "get": { "tags": [ "legalEntity" ], "description": "Get all legal entities", "operationId": "get_get_all_legal_entities", "responses": { "200": { "description": "Legal entities list" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/legalEntity\/{legalEntityId}": { "get": { "tags": [ "legalEntity" ], "description": "Get one legalEntity by id", "operationId": "get_get_legal_entity_by_id", "parameters": [ { "name": "legalEntityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One legalEntity", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LegalEntity2" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "legalEntity" ], "description": "Update on legalEntity by id", "operationId": "put_app_legalentity_updatelegalentitybyid", "parameters": [ { "name": "legalEntityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LegalEntity3" } } } }, "responses": { "204": { "description": "LegalEntity is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/client\/{clientId}\/legalEntity": { "post": { "tags": [ "legalEntity" ], "description": "Create legalEntity", "operationId": "post_app_legalentity_createlegalentity", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LegalEntity4" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/client\/{clientId}\/legalEntity\/{legalEntityId}": { "delete": { "tags": [ "legalEntity" ], "description": "Delete one legalEntity by id", "operationId": "delete_app_legalentity_deletelegalentity", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "legalEntityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LegalEntity deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/legalEntity": { "get": { "tags": [ "legalEntity" ], "description": "Get LegalEntity list by contract id", "operationId": "get_app_legalentity_getlegalentitybycontract", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LegalEntity list" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/legalEntity\/{legalEntityId}\/legalEntityMetadata": { "get": { "tags": [ "legalEntityMetadata" ], "description": "Get all legalEntityMetadatas by legalEntity", "operationId": "get_get_legal_entity_metadata", "parameters": [ { "name": "legalEntityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all legalEntityMetadatas" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "legalEntityMetadata" ], "description": "add meta data to legalEntity", "operationId": "post_app_legalentitymetadata_addlegalentitymetadatastolegalentity", "parameters": [ { "name": "legalEntityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/LegalEntityMetadata2" } } } }, "responses": { "201": { "description": "Return the legalEntity matadata link in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organizationContractService\/{organizationContractServiceId}": { "get": { "tags": [ "organizationContractService" ], "description": "Get one organization service by id", "operationId": "get_get_organization_contract_service_by_id", "parameters": [ { "name": "organizationContractServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One organization service", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrganizationContractService" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}\/organizationContractService": { "get": { "tags": [ "organizationContractService" ], "description": "Get organization services by organization", "operationId": "get_get_organization_service_by_organization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "serviceMetadata", "in": "query", "description": "The `serviceMetadata` field can contain one or more metadata separated by a comma in format JSON contain key value params. Example : `[{'key':'type','value':'SSO_APPLICATION'}]`", "required": false, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all Services of this Organization" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "organizationContractService" ], "description": "Create organization service", "operationId": "post_app_organizationcontractservice_createorganizationcontractservice", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrganizationContractService3" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}\/service\/{serviceCode}": { "delete": { "tags": [ "organizationContractService" ], "description": "Delete one OrganizationContractService by its organization id and service code", "operationId": "delete_app_organizationcontractservice_deletelegalentity", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "serviceCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OrganizationContractService deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organizationContractServiceOption\/{orgContractServiceOptionId}": { "get": { "tags": [ "organizationContractServiceOption" ], "description": "Get one organization service by id", "operationId": "get_get_organization_service_option_by_id", "parameters": [ { "name": "orgContractServiceOptionId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One organization service", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrganizationContractServiceOption" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organizationContractService\/{organizationContractServiceId}\/organizationContractServiceOption": { "get": { "tags": [ "organizationContractServiceOption" ], "description": "Get organization service options by organization service", "operationId": "get_get_organization_service_options_by_organization_service", "parameters": [ { "name": "organizationContractServiceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all Options of this OrganizationContractService" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "organizationContractServiceOption" ], "description": "Create organization service option", "operationId": "post_app_organizationcontractserviceoption_createorganizationcontractserviceoption", "parameters": [ { "name": "organizationContractServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrganizationContractServiceOption2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organizationContractService\/{organizationContractServiceId}\/serviceOption\/{serviceOptionCode}": { "delete": { "tags": [ "organizationContractServiceOption" ], "description": "Delete one OrganizationContractServiceOption by its organizationContractService and serviceOption id", "operationId": "delete_app_organizationcontractserviceoption_deleteorganizationcontractserviceoption", "parameters": [ { "name": "organizationContractServiceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "serviceOptionCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Entity deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/organization": { "get": { "tags": [ "organization" ], "description": "Get organizations by contract", "operationId": "get_get_organization_by_contract", "parameters": [ { "name": "q", "in": "query", "description": "query filter", "required": false, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "organizationType", "in": "query", "description": "Filter by organization type", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "Community", "ExternalEntity", "Operator" ] } } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Organizations by contract", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Organization" } } } } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "organization" ], "description": "Create contract organization", "operationId": "post_app_organization_createorganization", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Organization2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/organization\/{organizationId}": { "delete": { "tags": [ "organization" ], "description": "Delete one organization by id", "operationId": "delete_app_organization_deleteorganization", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Organization deleted" }, "403": { "description": "Organization is master and cannot be deleted!" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}": { "get": { "tags": [ "organization" ], "description": "Get one organization by id", "operationId": "get_get_organization_by_id", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One organization", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Organization3" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "organization" ], "description": "Update an organization by id", "operationId": "put_app_organization_updateorganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Organization4" } } } }, "responses": { "204": { "description": "Organization is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}\/category": { "put": { "tags": [ "organization" ], "description": "Add category to organization", "operationId": "put_app_organization_addorganizationcategory", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Category3" } } } }, "responses": { "200": { "description": "Ok" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}\/category\/{categoryId}": { "delete": { "tags": [ "organization" ], "description": "Remove category from organization", "operationId": "delete_app_organization_removeorganizationcategory", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "categoryId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Organization category deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}\/area\/{areaId}": { "delete": { "tags": [ "organization" ], "description": "Remove area from organization", "operationId": "delete_app_organization_removeorganizationarea", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "areaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Organization area removed" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/legalEntity\/{legalEntityId}\/organization": { "get": { "tags": [ "organization" ], "description": "Get organizations by Legal Entity", "operationId": "get_get_organization_by_legal_entity", "parameters": [ { "name": "legalEntityId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Organizations by legal entity", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Organization5" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/area\/{areaId}\/organization": { "get": { "tags": [ "organization" ], "description": "Get organizations by area", "operationId": "get_get_organization_by_area", "parameters": [ { "name": "organizationType", "in": "query", "description": "filter results by organization type", "required": false, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "areaId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Organizations by area", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Organization" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization": { "get": { "tags": [ "organization" ], "description": "Get list organization by criteria", "operationId": "get_get_organization_by_criteria", "parameters": [ { "name": "q", "in": "query", "description": "search q in organization to filter results", "required": false, "schema": { "type": "string" } }, { "name": "organizationMetadatas[key][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "organizationMetadatas[value][]", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "organizationMetadatasSearchMode", "in": "query", "description": "which mode to use (strict or non-strict), strict for searching the exact giving value, and non-strict to if the organizationMetadata contains the giving value", "required": false, "schema": { "type": "string", "default": "strict", "enum": [ "strict", "non-strict" ] } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all organizations by criteria" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organizationType": { "get": { "tags": [ "organizationType" ], "description": "Get all organizationType", "operationId": "get_get_all_organizationTypes", "responses": { "200": { "description": "One organizationType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrganizationType" } } } } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "organizationType" ], "description": "Create organizationType", "operationId": "post_app_organizationtype_createorganizationtype", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/OrganizationType2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/portal": { "get": { "tags": [ "portals" ], "description": "Get all portals", "operationId": "get_app_portal_getallportals", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all portals" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "portals" ], "description": "Create portal", "operationId": "post_app_portal_createportal", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Portal2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/portal\/{portalCode}": { "get": { "tags": [ "portals" ], "description": "Get on portal by code", "operationId": "get_app_portal_getportalbycode", "parameters": [ { "name": "portalCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One portal", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Portal" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/profile": { "get": { "tags": [ "profile" ], "description": "Get all profile", "operationId": "get_get_all_profiles", "responses": { "200": { "description": "One profile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Profile" } } } } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "profile" ], "description": "Create profile", "operationId": "post_app_profile_createprofile", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Profile2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/service": { "get": { "tags": [ "services" ], "description": "Get all services", "operationId": "get_app_service_getallservices", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all services" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "services" ], "description": "Create service", "operationId": "post_app_service_createservice", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Service2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/portal\/{portalCode}\/service": { "get": { "tags": [ "portals" ], "description": "Get all services by portal code", "operationId": "get_app_service_getallservicesbyportalcode", "parameters": [ { "name": "portalCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all services of this portal" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/service\/{serviceCode}": { "get": { "tags": [ "services" ], "description": "Get one service by code", "operationId": "get_app_service_getservicebycode", "parameters": [ { "name": "serviceCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One service", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Service" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "services" ], "description": "Update on service by id", "operationId": "put_app_service_updateservicebycode", "parameters": [ { "name": "serviceCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Service4" } } } }, "responses": { "204": { "description": "Service is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/service": { "get": { "tags": [ "services" ], "description": "Get all services of a contract", "operationId": "get_app_service_getallservicesbycontract", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all services of this portal" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/service\/{serviceCode}\/serviceMetadata": { "get": { "tags": [ "serviceMetadata" ], "description": "Get all serviceMetadatas by service", "operationId": "get_app_servicemetadata_getallservicemetadatasbyservice", "parameters": [ { "name": "serviceCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all serviceMetadatas" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "serviceMetadata" ], "description": "add meta data to service", "operationId": "post_app_servicemetadata_addservicemetadatastoservice", "parameters": [ { "name": "serviceCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ServiceMetadata2" } } } }, "responses": { "201": { "description": "Return the service matadata link in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/serviceOption": { "get": { "tags": [ "serviceOptions" ], "description": "Get all serviceOptions", "operationId": "get_app_serviceoption_getallserviceoptions", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all serviceOptions" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "serviceOptions" ], "description": "Create serviceOption", "operationId": "post_app_serviceoption_createserviceoption", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ServiceOption2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/service\/{serviceCode}\/serviceOption": { "get": { "tags": [ "serviceOptions" ], "description": "Get all serviceOptions by service code", "operationId": "get_app_serviceoption_getserviceoptionsbyservicecode", "parameters": [ { "name": "serviceCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all serviceOptions of this service" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/serviceOption\/{serviceOptionCode}": { "get": { "tags": [ "serviceOptions" ], "description": "Get on serviceOption by code", "operationId": "get_app_serviceoption_getserviceoptionbycode", "parameters": [ { "name": "serviceOptionCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One serviceOption", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ServiceOption" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "serviceOptions" ], "description": "Update one serviceOption by id", "operationId": "put_app_serviceoption_updateserviceoptionbycode", "parameters": [ { "name": "serviceOptionCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/ServiceOption4" } } } }, "responses": { "204": { "description": "ServiceOption is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/serviceOption": { "get": { "tags": [ "serviceOptions" ], "description": "Get all serviceOptions of a contract", "operationId": "get_app_serviceoption_getallserviceoptionsbycontract", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all serviceOptions of this contract" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/status": { "get": { "tags": [ "status" ], "description": "Get statuses", "operationId": "get_app_status_getallstatuss", "responses": { "200": { "description": "Returns all statuses" } } } }, "\/api\/user\/{userId}\/portal\/{portalCode}\/configuration": { "get": { "tags": [ "UserConfigurations" ], "description": "Get all user configuration for a given portal", "operationId": "get_get_all_user_configurations_by_portal", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "portalCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Array of UserConfiguration", "content": { "application\/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#\/components\/schemas\/User" }, { "$ref": "#\/components\/schemas\/Portal" } ] } } } } } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "userConfigurations" ], "description": "Create UserConfiguration", "operationId": "post_post_user_configuration", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "portalCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserConfiguration" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" }, "400": { "description": "another configuration already exists for this combination of user portal and configuration code OR one of url parameter is not equal to body parameter" }, "404": { "description": "given user or portal doesn't exists" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/portal\/{portalCode}\/configuration\/{code}": { "get": { "tags": [ "userConfigurations" ], "description": "Get a user configuration for a given portal identified by a code key", "operationId": "get_get_user_configuration_for_portal_by_code", "parameters": [ { "name": "showDeleted", "in": "query", "description": "Force returning soft-deleted records", "required": false, "schema": { "type": "boolean" } }, { "name": "userId", "in": "path", "description": "ID of the user", "required": true, "schema": { "type": "string" } }, { "name": "portalCode", "in": "path", "description": "Code of the portal", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "description": "Configuration code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One UserConfiguration or null if none found", "content": { "application\/json": { "schema": { "oneOf": [ { "$ref": "#\/components\/schemas\/User" }, { "$ref": "#\/components\/schemas\/Portal" } ] } } } }, "204": { "description": "No configuration found for given user, portal, and code" } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "userConfigurations" ], "description": "Update userConfiguration by user, portal and configuration code", "operationId": "put_put_user_configuration", "parameters": [ { "name": "editDeleted", "in": "query", "description": "Edit a deleted configuration", "schema": { "type": "boolean" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "portalCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserConfiguration2" } } } }, "responses": { "204": { "description": "UserConfiguration is updated" } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "userConfigurations" ], "description": "Delete one user configuration by user, portal and configuration code", "operationId": "delete_delete_user_configuration", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "portalCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "UserConfiguration is deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userContract": { "get": { "tags": [ "userContracts" ], "description": "Get all userContracts", "operationId": "get_app_usercontract_getallusercontracts", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all userContracts" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "userContracts" ], "description": "Create userContract", "operationId": "post_app_usercontract_createusercontract", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserContract2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/userContract": { "get": { "tags": [ "userContracts" ], "description": "Get all userContract by contract", "operationId": "get_app_usercontract_getallusercontractbycontract", "parameters": [ { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all userContract by contract" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/userContract": { "get": { "tags": [ "userContracts" ], "description": "Get all userContract by user", "operationId": "get_app_usercontract_getallusercontractbyuser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all userContract by user" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userContract\/{userContractId}": { "get": { "tags": [ "userContracts" ], "description": "Get one userContract by id", "operationId": "get_app_usercontract_getusercontractbyid", "parameters": [ { "name": "userContractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One userContract", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserContract4" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "userContracts" ], "description": "Update one userContract by id", "operationId": "put_app_usercontract_updateusercontractbyid", "parameters": [ { "name": "userContractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserContract5" } } } }, "responses": { "204": { "description": "userContract is updated" } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "userContracts" ], "description": "Delete one user contrat by id", "operationId": "delete_app_usercontract_deleteusercontractbyid", "parameters": [ { "name": "userContractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "User contract is deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userContractService": { "get": { "tags": [ "userContractServices" ], "description": "Get all contract services", "operationId": "get_app_usercontractservice_getallusercontractservices", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all contract services" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "userContractServices" ], "description": "Create user contract service", "operationId": "post_app_usercontractservice_createusercontractservice", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserContractService2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userContractService\/{userContractServiceId}": { "get": { "tags": [ "userContractServices" ], "description": "Get one contract service by id", "operationId": "get_app_usercontractservice_getusercontractservicebyid", "parameters": [ { "name": "userContractServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One contract service", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserContractService" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "userContractServices" ], "description": "Update a user contract service by id", "operationId": "put_app_usercontractservice_updateusercontractservicebyid", "parameters": [ { "name": "userContractServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserContractService3" } } } }, "responses": { "204": { "description": "Contract service is updated" } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "userContractServices" ], "description": "Delete one user contract service by id", "operationId": "delete_app_usercontractservice_deleteusercontractservicebyid", "parameters": [ { "name": "userContractServiceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "User contract service is deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userContract\/{userContractId}\/userContractService": { "get": { "tags": [ "userContractServices" ], "description": "Get all contract service of a contract", "operationId": "get_app_usercontractservice_getusercontractservicebyusercontract", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "userContractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all contract services for this contract" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user": { "get": { "tags": [ "users" ], "description": "Get all users", "operationId": "get_app_user_getallusers", "parameters": [ { "name": "q", "in": "query", "description": "search q in user to filter results", "required": false, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "ldapDn", "in": "query", "description": "filter on ldapDn with equality comparaison", "required": false, "schema": { "type": "string" } }, { "name": "ldapUidNumber", "in": "query", "description": "filter on ldapUidNumber with equality comparaison", "required": false, "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "filter on username with equality comparaison", "required": false, "schema": { "type": "string" } }, { "name": "areaIdsFilter[]", "in": "query", "description": "filter users by the areaIds it can access.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "typeIdsFilter[]", "in": "query", "description": "filter users by their type.", "required": false, "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "onlyAttributes[]", "in": "query", "description": "filter selected attributed for smaller returned entities", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "Returns all users" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "users" ], "description": "Create user", "operationId": "post_app_user_createuser", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User3" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}": { "get": { "tags": [ "users" ], "description": "Get on user by id", "operationId": "get_app_user_getuserbyid", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One user", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User2" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "users" ], "description": "Update on user by id", "operationId": "put_app_user_updateuserbyid", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User3" } } } }, "responses": { "204": { "description": "User is updated" } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "users" ], "description": "Delete one user by id", "operationId": "delete_app_user_deleteusercontractbyid", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "User is deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/permissions": { "get": { "tags": [ "users" ], "description": "Get full or simplify user permissions", "operationId": "get_app_user_getuserpermission", "parameters": [ { "name": "portalCode", "in": "query", "description": "Returns only result for this portal", "required": false, "schema": { "type": "string" } }, { "name": "simplify", "in": "query", "description": "If true return siplify version", "required": false, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of user contracts and their links to the services", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserContract6" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/assign-rights": { "post": { "tags": [ "users" ], "description": "Assign user source rigths to the user destination. ", "operationId": "post_app_user_assignuserrights", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "userSource": { "type": "string" }, "userDestination": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/duplicate-contract-permissions": { "post": { "tags": [ "users" ], "description": "Duplicate source contract permission to destination contrat for given user. ", "operationId": "post_app_user_duplicatecontractpermissions", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "properties": { "userId": { "type": "string" }, "contractSourceId": { "type": "string" }, "contractDestinationId": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/user": { "get": { "tags": [ "users" ], "description": "Get all users that can access a given contract, be it by userContract, userOrganization or UserProfile", "operationId": "get_app_user_getusersbycontract", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "userFilter", "in": "query", "description": "Filter on user firstname or lastname or username", "required": false, "schema": { "type": "string" } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Users list" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}\/user": { "get": { "tags": [ "users" ], "description": "Get all users from organization", "operationId": "get_get_users_by_organization", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Users list" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/import\/users": { "post": { "tags": [ "import" ], "description": "Create user", "operationId": "post_app_userimport_index", "requestBody": { "required": true, "content": { "multipart\/form-data": { "schema": { "required": [ "file" ], "properties": { "file": { "description": "The Excel file to upload", "type": "string", "format": "binary" } }, "type": "object" } } } }, "responses": { "201": { "description": "Import successed" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/userMetadata": { "get": { "tags": [ "userMetadata" ], "description": "Get all userMetadatas by user", "operationId": "get_app_usermetadata_getallusermetadatabyuser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all userMetadatas" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "userMetadata" ], "description": "add meta data to user", "operationId": "post_app_usermetadata_addusermetadatastouser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserMetadata2" } } } }, "responses": { "201": { "description": "Return the user matadata link in 'location' header" } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "userMetadata" ], "description": "delete metadata to user", "operationId": "delete_app_usermetadata_deleteusermetadatastouser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserMetadata2" } } } }, "responses": { "204": { "description": "Return always 204 same if metadata already delete" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}\/UserOrganization": { "post": { "tags": [ "UserOrganization" ], "description": "Create user organization by organization", "operationId": "post_app_userorganization_createuserorganizationbyorganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserOrganization" } } } }, "responses": { "200": { "description": "User added to organization" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/UserOrganization": { "post": { "tags": [ "UserOrganization" ], "description": "Create user organization by user", "operationId": "post_app_userorganization_createuserorganizationbyuser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserOrganization" } } } }, "responses": { "200": { "description": "User added to organization" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}\/User\/{userId}": { "delete": { "tags": [ "UserOrganization" ], "description": "Remove user from organization", "operationId": "delete_app_userorganization_olddeleteuserorganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "User removed from organization" } }, "deprecated": true, "security": [ { "apiToken": [] } ] } }, "\/api\/organization\/{organizationId}\/user\/{userId}": { "delete": { "tags": [ "UserOrganization" ], "description": "Remove user from organization", "operationId": "delete_app_userorganization_deleteuserorganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "User removed from organization" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/contract\/{contractId}\/organization\/user": { "get": { "tags": [ "UserOrganization" ], "description": "Get organization users by contract", "operationId": "get_get_organization_user_by_contract", "parameters": [ { "name": "organizationType", "in": "query", "description": "Filter by organization type", "required": false, "style": "form", "explode": false, "schema": { "type": "array", "items": {} } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Organization users by contract", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/User" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/organization": { "get": { "tags": [ "UserOrganization" ], "description": "Get organizations by user", "operationId": "get_get_organization_by_user", "parameters": [ { "name": "organizationType", "in": "query", "description": "Filter by organization type", "required": false, "schema": { "type": "string", "enum": [ "Community", "ExternalEntity", "Operator" ] } }, { "name": "serviceCode", "in": "query", "description": "Filter by service activated on Organization", "required": false, "schema": { "type": "string" } }, { "name": "contractId", "in": "query", "description": "Filter by contract", "required": false, "schema": { "type": "string" } }, { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Organizations by user", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Organization6" } } } } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userProfile": { "get": { "tags": [ "UserProfile" ], "description": "Get all userProfiles", "operationId": "get_app_userprofile_getalluserprofiles", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all userProfiles" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "UserProfile" ], "description": "Create userProfile", "operationId": "post_app_userprofile_createuserprofile", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserProfile2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userProfile\/contract\/{contractId}": { "get": { "tags": [ "UserProfile" ], "description": "Get all userProfiles by contract", "operationId": "get_app_userprofile_getalluserprofilesbycontract", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "profileCode", "in": "query", "description": "code profile", "required": false, "schema": { "type": "string" } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all userProfiles" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userProfile\/organization\/{organizationId}": { "get": { "tags": [ "UserProfile" ], "description": "Get all userProfiles by organization", "operationId": "get_app_userprofile_getalluserprofilesbyorganization", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "profileCode", "in": "query", "description": "code profile", "required": false, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all userProfiles" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userProfile\/portal\/{portalCode}": { "get": { "tags": [ "UserProfile" ], "description": "Get all userProfiles by portal", "operationId": "get_app_userprofile_getalluserprofilesbyportal", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } }, { "name": "profileCode", "in": "query", "description": "code profile", "required": false, "schema": { "type": "string" } }, { "name": "portalCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all userProfiles" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/userProfile": { "get": { "tags": [ "UserProfile" ], "description": "Get all userProfile by user", "operationId": "get_app_userprofile_getalluserprofilebyuser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns all userProfile by user" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userProfile\/{userProfileId}": { "get": { "tags": [ "UserProfile" ], "description": "Get one userProfile by id", "operationId": "get_app_userprofile_getuserprofilebyid", "parameters": [ { "name": "userProfileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One userProfile", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserProfile" } } } } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "UserProfile" ], "description": "Delete one user profile by id", "operationId": "delete_app_userprofile_deleteuserprofilebyid", "parameters": [ { "name": "userProfileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "User profile is deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/userProfile\/{userProfileId}": { "put": { "tags": [ "UserProfile" ], "description": "Update one userProfile by id", "operationId": "put_app_userprofile_updateuserprofilebyid", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userProfileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserProfile4" } } } }, "responses": { "204": { "description": "userProfile is updated" } }, "security": [ { "apiToken": [] } ] }, "delete": { "tags": [ "UserProfile" ], "description": "Delete one user profile by id", "operationId": "delete_app_userprofile_deleteuserprofilebyuserandid", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "userProfileId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "User profile is deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/profile\/{profileCode}": { "delete": { "tags": [ "UserProfile" ], "description": "Delete one user profile by profile code", "operationId": "delete_app_userprofile_deleteuserprofilebyuserandprofile", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "User profile is deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/profile\/{profileCode}\/organization\/{organizationId}": { "delete": { "tags": [ "UserProfile" ], "description": "Delete one organization of a user profile", "operationId": "delete_app_userprofile_deleteuserprofileorganization", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "organizationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The organization of the user profile is deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/profile\/{profileCode}\/contract\/{contractId}": { "delete": { "tags": [ "UserProfile" ], "description": "Delete one contrat of a user profile", "operationId": "delete_app_userprofile_deleteuserprofilecontract", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contractId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The contract of the user profile is deleted" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/profile\/{profileCode}\/contracts": { "put": { "tags": [ "UserProfile" ], "description": "add contract for a user profile", "operationId": "put_app_userprofile_adduserprofilecontract", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Contract5" } } } }, "responses": { "204": { "description": "userProfile is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/user\/{userId}\/profile\/{profileCode}\/organizations": { "put": { "tags": [ "UserProfile" ], "description": "add organization for a user profile", "operationId": "put_app_userprofile_adduserprofileorganization", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "profileCode", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/Organization7" } } } }, "responses": { "204": { "description": "userProfile is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userType": { "get": { "tags": [ "userTypes" ], "description": "Get all userTypes", "operationId": "get_app_usertype_getallusertypes", "parameters": [ { "name": "currentPage", "in": "query", "description": "current page for pagination offset", "required": false, "schema": { "type": "number", "default": 1 } }, { "name": "itemsPerPage", "in": "query", "description": "Nb items per page for pagination", "required": false, "schema": { "type": "number", "default": 20 } } ], "responses": { "200": { "description": "Returns all userTypes" } }, "security": [ { "apiToken": [] } ] }, "post": { "tags": [ "userTypes" ], "description": "Create userType", "operationId": "post_app_usertype_createusertype", "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserType2" } } } }, "responses": { "201": { "description": "Return the created ressource in 'location' header" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/userType\/{userTypeId}": { "get": { "tags": [ "userTypes" ], "description": "Get on userType by id", "operationId": "get_app_usertype_getusertypebyid", "parameters": [ { "name": "userTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "One userType", "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserType" } } } } }, "security": [ { "apiToken": [] } ] }, "put": { "tags": [ "userTypes" ], "description": "Update on userType by id", "operationId": "put_app_usertype_updateusertypebyid", "parameters": [ { "name": "userTypeId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application\/json": { "schema": { "$ref": "#\/components\/schemas\/UserType3" } } } }, "responses": { "204": { "description": "UserType is updated" } }, "security": [ { "apiToken": [] } ] } }, "\/api\/doc.json": { "get": { "responses": { "default": { "description": "" } } } } }, "components": { "schemas": { "Area": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "areaMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AreaMetadata3" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "type": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Area2": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "areaMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AreaMetadata4" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" } }, "type": "object" }, "Area3": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "areaMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AreaMetadata5" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" } }, "type": "object" }, "Area4": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" } }, "type": "object" }, "AreaMetadata": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "AreaMetadata2": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "AreaType": { "properties": { "id": { "title": "Id of type, manually generated", "type": "string" }, "label": { "title": "Label of type", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "AreaType2": { "properties": { "id": { "title": "Id of type, manually generated", "type": "string" }, "label": { "title": "Label of type", "type": "string" } }, "type": "object" }, "AreaType3": { "properties": { "id": { "title": "Id of type, manually generated", "type": "string" }, "label": { "title": "Label of type", "type": "string" } }, "type": "object" }, "Category": { "properties": { "id": { "title": "UUID of Category", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label of this category", "type": "string" }, "externalId": { "title": "External Id of this category", "type": "string" }, "parentCategory": { "$ref": "#\/components\/schemas\/Category" }, "active": { "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Category2": { "required": [ "categoryType" ], "properties": { "categoryType": { "$ref": "#\/components\/schemas\/CategoryType" }, "label": { "title": "Label of this category", "type": "string" }, "externalId": { "title": "External Id of this category", "type": "string" }, "parentCategory": { "$ref": "#\/components\/schemas\/Category2" }, "active": { "type": "boolean" } }, "type": "object" }, "Client": { "required": [ "label" ], "properties": { "type": { "title": "client type as Id", "type": "string" }, "clientMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ClientMetadata3" } }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label for this client", "type": "string" }, "departmentCode": { "title": "Department code", "type": "string" }, "description": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contracts": { "properties": { "href": { "type": "string" } }, "type": "object" }, "type": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Client2": { "required": [ "label" ], "properties": { "type": { "title": "client type as Id", "type": "string" }, "clientMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ClientMetadata4" } }, "label": { "title": "Label for this client", "type": "string" }, "departmentCode": { "title": "Department code", "type": "string" }, "description": { "type": "string" } }, "type": "object" }, "Client3": { "required": [ "label" ], "properties": { "type": { "title": "client type as Id", "type": "string" }, "clientMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ClientMetadata5" } }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label for this client", "type": "string" }, "departmentCode": { "title": "Department code", "type": "string" }, "description": { "type": "string" } }, "type": "object" }, "ClientMetadata": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ClientMetadata2": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "ClientType": { "properties": { "id": { "title": "Id of type, manualy generated", "type": "string" }, "label": { "title": "Label of type", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ClientType2": { "properties": { "id": { "title": "Id of type, manualy generated", "type": "string" }, "label": { "title": "Label of type", "type": "string" } }, "type": "object" }, "ClientType3": { "properties": { "id": { "title": "Id of type, manualy generated", "type": "string" }, "label": { "title": "Label of type", "type": "string" } }, "type": "object" }, "ContractArea": { "required": [ "area" ], "properties": { "contract": { "title": "contract as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "area": { "$ref": "#\/components\/schemas\/Area5" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ContractArea2": { "properties": { "contract": { "title": "contract as Id", "type": "string" }, "area": { "title": "Area as Id", "type": "string" } }, "type": "object" }, "ContractArea3": { "properties": { "contract": { "title": "contract as Id", "type": "string" }, "area": { "title": "Area as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" } }, "type": "object" }, "Contract": { "required": [ "label", "client" ], "properties": { "contractMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractMetadata3" } }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "status": { "title": "Status of this contract", "type": "string" }, "label": { "title": "Label of this contract", "type": "string" }, "client": { "$ref": "#\/components\/schemas\/Client4" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractAreas": { "properties": { "href": { "type": "string" } }, "type": "object" }, "services": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Contract2": { "required": [ "label" ], "properties": { "client": { "title": "Related client as Id", "type": "string" }, "contractMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractMetadata4" } }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "status": { "title": "Status of this contract", "type": "string" }, "label": { "title": "Label of this contract", "type": "string" } }, "type": "object" }, "Contract3": { "required": [ "label" ], "properties": { "client": { "title": "Related client as Id", "type": "string" }, "contractMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractMetadata5" } }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "status": { "title": "Status of this contract", "type": "string" }, "label": { "title": "Label of this contract", "type": "string" } }, "type": "object" }, "Contract4": { "required": [ "label" ], "properties": { "contractMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractMetadata6" } }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "status": { "title": "Status of this contract", "type": "string" }, "label": { "title": "Label of this contract", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractAreas": { "properties": { "href": { "type": "string" } }, "type": "object" }, "services": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractMetadata": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ContractMetadata2": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "ContractService": { "required": [ "service" ], "properties": { "contract": { "title": "Related contract as ID", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "contractServiceOptions": { "type": "string" }, "service": { "$ref": "#\/components\/schemas\/Service5" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractService2": { "properties": { "contract": { "title": "Related contract as ID", "type": "string" }, "service": { "title": "Related service code", "type": "string" } }, "type": "object" }, "ContractService3": { "properties": { "contract": { "title": "Related contract as ID", "type": "string" }, "service": { "title": "Related service code", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" } }, "type": "object" }, "ContractServiceOption": { "required": [ "serviceOption" ], "properties": { "contractService": { "title": "Related contractService as Id", "type": "string" }, "service": { "title": "Related service code", "type": "string" }, "contract": { "title": "Related contract as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "serviceOption": { "$ref": "#\/components\/schemas\/ServiceOption5" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "contractService": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractServiceOption2": { "properties": { "contractService": { "title": "Related contractService as Id", "type": "string" }, "serviceOption": { "title": "Related service option code", "type": "string" } }, "type": "object" }, "ContractServiceOption3": { "required": [ "serviceOption" ], "properties": { "contractService": { "title": "Related contractService as Id", "type": "string" }, "service": { "title": "Related service code", "type": "string" }, "contract": { "title": "Related contract as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "serviceOption": { "$ref": "#\/components\/schemas\/ServiceOption6" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "contractService": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractServiceOption4": { "properties": { "contractService": { "title": "Related contractService as Id", "type": "string" }, "serviceOption": { "title": "Related service option code", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" } }, "type": "object" }, "ContractServiceOption5": { "required": [ "serviceOption" ], "properties": { "contractService": { "title": "Related contractService as Id", "type": "string" }, "service": { "title": "Related service code", "type": "string" }, "contract": { "title": "Related contract as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "serviceOption": { "$ref": "#\/components\/schemas\/ServiceOption7" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "contractService": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntity": { "required": [ "client" ], "properties": { "legalEntityMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/LegalEntityMetadata3" } }, "id": { "title": "UUID of Legal Entity", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "client": { "$ref": "#\/components\/schemas\/Client5" }, "label": { "title": "Label of this legal entity", "type": "string" }, "status": { "title": "Status of this legal entity", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "metadata": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntity2": { "required": [ "client" ], "properties": { "legalEntityMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/LegalEntityMetadata4" } }, "id": { "title": "UUID of Legal Entity", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "client": { "$ref": "#\/components\/schemas\/Client6" }, "label": { "title": "Label of this legal entity", "type": "string" }, "status": { "title": "Status of this legal entity", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "metadata": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntity3": { "properties": { "client": { "title": "Related client as Id", "type": "string" }, "legalEntityMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/LegalEntityMetadata5" } }, "id": { "title": "UUID of Legal Entity", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label of this legal entity", "type": "string" }, "status": { "title": "Status of this legal entity", "type": "string" } }, "type": "object" }, "LegalEntity4": { "properties": { "client": { "title": "Related client as Id", "type": "string" }, "legalEntityMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/LegalEntityMetadata6" } }, "label": { "title": "Label of this legal entity", "type": "string" }, "status": { "title": "Status of this legal entity", "type": "string" } }, "type": "object" }, "LegalEntityMetadata": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "legalEntity": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntityMetadata2": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "OrganizationContractService": { "required": [ "organization", "contractService" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "organizationContractServiceOptions": { "type": "string" }, "organization": { "$ref": "#\/components\/schemas\/Organization8" }, "contractService": { "$ref": "#\/components\/schemas\/ContractService4" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractService": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "OrganizationContractService2": { "required": [ "organization", "contractService" ], "properties": { "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "organizationContractServiceOptions": { "type": "string" }, "organization": { "$ref": "#\/components\/schemas\/Organization9" }, "contractService": { "$ref": "#\/components\/schemas\/ContractService5" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractService": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "OrganizationContractService3": { "properties": { "organization": { "title": "Related organization as ID", "type": "string" }, "contractService": { "title": "Related contract service as ID", "type": "string" } }, "type": "object" }, "OrganizationContractServiceOption": { "properties": { "organizationContractService": { "title": "Related organizationContractService as Id", "type": "string" }, "serviceOption": { "title": "Related service option code", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "organizationContractService": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractService": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "OrganizationContractServiceOption2": { "properties": { "organizationContractService": { "title": "Related organizationContractService as Id", "type": "string" }, "serviceOption": { "title": "Related service option code", "type": "string" } }, "type": "object" }, "Organization": { "required": [ "organizationType" ], "properties": { "contract": { "title": "contract as ID", "type": "string" }, "organizationType": { "title": "Organization type as ID", "type": "string" }, "id": { "title": "UUID of Organization", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "areas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Area6" } }, "organizationMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrganizationMetadata" } }, "legalEntity": { "$ref": "#\/components\/schemas\/LegalEntity5" }, "label": { "title": "Label of this category", "type": "string" }, "status": { "title": "Status of that organization", "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category4" } }, "organizationMaster": { "title": "Organization master enabled or disabled", "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Organization2": { "properties": { "contract": { "title": "contract as ID", "type": "string" }, "legalEntity": { "title": "Legal entity as ID", "type": "string" }, "organizationType": { "title": "Organization type as ID", "type": "string" }, "areas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Area7" } }, "organizationMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrganizationMetadata2" } }, "label": { "title": "Label of this category", "type": "string" }, "status": { "title": "Status of that organization", "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category5" } }, "organizationMaster": { "title": "Organization master enabled or disabled", "type": "boolean" } }, "type": "object" }, "Organization3": { "properties": { "contract": { "title": "contract as ID", "type": "string" }, "organizationType": { "title": "Organization type as ID", "type": "string" }, "id": { "title": "UUID of Organization", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "areas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Area8" } }, "organizationMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrganizationMetadata3" } }, "legalEntity": { "$ref": "#\/components\/schemas\/LegalEntity6" }, "label": { "title": "Label of this category", "type": "string" }, "status": { "title": "Status of that organization", "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category6" } }, "organizationMaster": { "title": "Organization master enabled or disabled", "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Organization4": { "properties": { "contract": { "title": "contract as ID", "type": "string" }, "legalEntity": { "title": "Legal entity as ID", "type": "string" }, "organizationType": { "title": "Organization type as ID", "type": "string" }, "id": { "title": "UUID of Organization", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "areas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Area9" } }, "organizationMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrganizationMetadata4" } }, "label": { "title": "Label of this category", "type": "string" }, "status": { "title": "Status of that organization", "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category7" } }, "organizationMaster": { "title": "Organization master enabled or disabled", "type": "boolean" } }, "type": "object" }, "Category3": { "properties": { "id": { "title": "UUID of Category", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label of this category", "type": "string" }, "externalId": { "title": "External Id of this category", "type": "string" }, "parentCategory": { "$ref": "#\/components\/schemas\/Category3" }, "active": { "type": "boolean" } }, "type": "object" }, "Organization5": { "properties": { "contract": { "title": "contract as ID", "type": "string" }, "organizationType": { "title": "Organization type as ID", "type": "string" }, "id": { "title": "UUID of Organization", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "areas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Area10" } }, "organizationMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrganizationMetadata5" } }, "legalEntity": { "$ref": "#\/components\/schemas\/LegalEntity7" }, "label": { "title": "Label of this category", "type": "string" }, "status": { "title": "Status of that organization", "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category8" } }, "organizationMaster": { "title": "Organization master enabled or disabled", "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationType": { "required": [ "code", "label" ], "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "OrganizationType2": { "required": [ "code", "label" ], "properties": { "code": { "type": "string" }, "label": { "type": "string" } }, "type": "object" }, "Portal": { "required": [ "code", "shortDescription" ], "properties": { "code": { "title": "Unique code of the portal", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "shortDescription": { "title": "Long description", "type": "string" }, "longDescription": { "title": "Short description", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "services": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Portal2": { "required": [ "code", "shortDescription" ], "properties": { "code": { "title": "Unique code of the portal", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "shortDescription": { "title": "Long description", "type": "string" }, "longDescription": { "title": "Short description", "type": "string" } }, "type": "object" }, "Profile": { "required": [ "code", "label" ], "properties": { "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Label of profile", "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Profile2": { "required": [ "code", "label" ], "properties": { "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Label of profile", "type": "string" } }, "type": "object" }, "Service": { "required": [ "code", "label" ], "properties": { "categories": { "title": "Related categories' id.", "type": "array", "items": [ { "type": "string" } ] }, "serviceMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ServiceMetadata3" } }, "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Lable of service", "type": "string" }, "description": { "title": "Description of service", "type": "string" }, "enabled": { "title": "Service enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" }, "portal": { "$ref": "#\/components\/schemas\/Portal3" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "portal": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Service2": { "required": [ "code", "label" ], "properties": { "categories": { "title": "Related categories' id.", "type": "array", "items": [ { "type": "string" } ] }, "portal": { "title": "Related portal as Id", "type": "string" }, "serviceMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ServiceMetadata4" } }, "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Lable of service", "type": "string" }, "description": { "title": "Description of service", "type": "string" }, "enabled": { "title": "Service enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" } }, "type": "object" }, "Service3": { "required": [ "code", "label" ], "properties": { "categories": { "title": "Related categories' id.", "type": "array", "items": [ { "type": "string" } ] }, "serviceMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ServiceMetadata5" } }, "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Lable of service", "type": "string" }, "description": { "title": "Description of service", "type": "string" }, "enabled": { "title": "Service enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "portal": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Service4": { "required": [ "code", "label" ], "properties": { "categories": { "title": "Related categories' id.", "type": "array", "items": [ { "type": "string" } ] }, "portal": { "title": "Related portal as Id", "type": "string" }, "serviceMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ServiceMetadata6" } }, "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Lable of service", "type": "string" }, "description": { "title": "Description of service", "type": "string" }, "enabled": { "title": "Service enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" } }, "type": "object" }, "ServiceMetadata": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ServiceMetadata2": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "ServiceOption": { "required": [ "code" ], "properties": { "code": { "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "type": "string" }, "description": { "type": "string" }, "enabled": { "title": "Service option enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service option", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" }, "service": { "$ref": "#\/components\/schemas\/Service6" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ServiceOption2": { "required": [ "code" ], "properties": { "service": { "title": "Related service as code", "type": "string" }, "code": { "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "type": "string" }, "description": { "type": "string" }, "enabled": { "title": "Service option enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service option", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" } }, "type": "object" }, "ServiceOption3": { "required": [ "code" ], "properties": { "code": { "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "type": "string" }, "description": { "type": "string" }, "enabled": { "title": "Service option enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service option", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ServiceOption4": { "required": [ "code" ], "properties": { "service": { "title": "Related service as code", "type": "string" }, "code": { "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "type": "string" }, "description": { "type": "string" }, "enabled": { "title": "Service option enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service option", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" } }, "type": "object" }, "User": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "userMetadata": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserMetadata3" } }, "id": { "title": "UUID of User", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "username": { "title": "Username", "type": "string" }, "ldapDn": { "title": "Ldap DN", "type": "string" }, "ldapUidNumber": { "title": "Ldap uidNumber", "type": "string" }, "suezGid": { "title": "Suez GID", "type": "string" }, "civility": { "title": "Civility", "type": "string" }, "lastName": { "title": "Lastname", "type": "string" }, "firstName": { "title": "firstname", "type": "string" }, "function": { "title": "Function of user", "type": "string" }, "phone": { "title": "Regular phone", "type": "string" }, "mobilePhone": { "title": "Mobile phone", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "type": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contracts": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "UserConfiguration": { "properties": { "user": { "title": "user as Id", "type": "string" }, "portal": { "title": "Related portal as Id", "type": "string" }, "code": { "type": "string" }, "data": { "type": "string" } }, "type": "object" }, "UserConfiguration2": { "properties": { "user": { "title": "user as Id", "type": "string" }, "portal": { "title": "Related portal as Id", "type": "string" }, "code": { "type": "string" }, "data": { "type": "string" } }, "type": "object" }, "UserContract": { "properties": { "user": { "title": "user as Id", "type": "string" }, "contract": { "title": "contract as Id", "type": "string" }, "contractAreas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "userContractServices": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "UserContract2": { "properties": { "user": { "title": "user as Id", "type": "string" }, "contract": { "title": "contract as Id", "type": "string" }, "contractAreas": { "type": "array", "items": { "type": "string" } } }, "type": "object" }, "UserContract3": { "required": [ "contract" ], "properties": { "user": { "title": "user as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "contract": { "$ref": "#\/components\/schemas\/Contract6" }, "contractAreas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractArea4" } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "userContractServices": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "UserContract4": { "properties": { "user": { "title": "user as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "userContractServices": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "UserContract5": { "properties": { "user": { "title": "user as Id", "type": "string" }, "contract": { "title": "contract as Id", "type": "string" }, "contractAreas": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" } }, "type": "object" }, "UserContractService": { "properties": { "userContract": { "title": "Related user contract as Id", "type": "string" }, "contractServices": { "title": "Related service code", "type": "array", "items": { "type": "string" } }, "contractServiceOptions": { "title": "Related service option code", "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "UserContractService2": { "properties": { "userContract": { "title": "Related user contract as Id", "type": "string" }, "contractServices": { "title": "Related service code", "type": "array", "items": { "type": "string" } }, "contractServiceOptions": { "title": "Related service option code", "type": "array", "items": { "type": "string" } } }, "type": "object" }, "UserContractService3": { "properties": { "userContract": { "title": "Related user contract as Id", "type": "string" }, "contractServices": { "title": "Related service code", "type": "array", "items": { "type": "string" } }, "contractServiceOptions": { "title": "Related service option code", "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" } }, "type": "object" }, "UserContractService4": { "properties": { "userContract": { "title": "Related user contract as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "contractServices": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractService6" }, "minItems": 1 }, "contractServiceOptions": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractServiceOption6" } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "User2": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "userMetadata": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserMetadata4" } }, "id": { "title": "UUID of User", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "username": { "title": "Username", "type": "string" }, "ldapDn": { "title": "Ldap DN", "type": "string" }, "ldapUidNumber": { "title": "Ldap uidNumber", "type": "string" }, "suezGid": { "title": "Suez GID", "type": "string" }, "civility": { "title": "Civility", "type": "string" }, "lastName": { "title": "Lastname", "type": "string" }, "firstName": { "title": "firstname", "type": "string" }, "function": { "title": "Function of user", "type": "string" }, "phone": { "title": "Regular phone", "type": "string" }, "mobilePhone": { "title": "Mobile phone", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "type": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contracts": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "User3": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "userMetadata": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserMetadata5" } }, "username": { "title": "Username", "type": "string" }, "ldapDn": { "title": "Ldap DN", "type": "string" }, "ldapUidNumber": { "title": "Ldap uidNumber", "type": "string" }, "suezGid": { "title": "Suez GID", "type": "string" }, "civility": { "title": "Civility", "type": "string" }, "lastName": { "title": "Lastname", "type": "string" }, "firstName": { "title": "firstname", "type": "string" }, "function": { "title": "Function of user", "type": "string" }, "phone": { "title": "Regular phone", "type": "string" }, "mobilePhone": { "title": "Mobile phone", "type": "string" } }, "type": "object" }, "UserContract6": { "required": [ "contract" ], "properties": { "user": { "title": "user as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "contract": { "$ref": "#\/components\/schemas\/Contract7" }, "contractAreas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractArea5" } }, "userContractServices": { "type": "array", "items": { "$ref": "#\/components\/schemas\/UserContractService5" } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "userContractServices": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "UserMetadata": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "UserMetadata2": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "UserOrganization": { "properties": { "user": { "title": "user as Id", "type": "string" }, "organization": { "title": "organization as Id", "type": "string" } }, "type": "object" }, "Organization6": { "properties": { "contract": { "title": "contract as ID", "type": "string" }, "organizationType": { "title": "Organization type as ID", "type": "string" }, "id": { "title": "UUID of Organization", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "areas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Area11" } }, "organizationMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrganizationMetadata6" } }, "legalEntity": { "$ref": "#\/components\/schemas\/LegalEntity8" }, "label": { "title": "Label of this category", "type": "string" }, "status": { "title": "Status of that organization", "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category9" } }, "organizationMaster": { "title": "Organization master enabled or disabled", "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "UserProfile": { "required": [ "profile" ], "properties": { "user": { "title": "user as Id", "type": "string" }, "profile": { "$ref": "#\/components\/schemas\/Profile3" }, "contracts": { "type": "array", "items": { "type": "string" } }, "organizations": { "type": "array", "items": { "type": "string" } }, "portals": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "UserProfile2": { "properties": { "user": { "title": "user as Id", "type": "string" }, "profile": { "title": "profile as Code", "type": "string" }, "contracts": { "type": "array", "items": { "type": "string" } }, "organizations": { "type": "array", "items": { "type": "string" } }, "portals": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" } }, "type": "object" }, "UserProfile3": { "required": [ "profile" ], "properties": { "user": { "title": "user as Id", "type": "string" }, "profile": { "$ref": "#\/components\/schemas\/Profile4" }, "contracts": { "type": "array", "items": { "type": "string" } }, "organizations": { "type": "array", "items": { "type": "string" } }, "portals": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "UserProfile4": { "properties": { "user": { "title": "user as Id", "type": "string" }, "profile": { "title": "profile as Code", "type": "string" }, "contracts": { "type": "array", "items": { "type": "string" } }, "organizations": { "type": "array", "items": { "type": "string" } }, "portals": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" } }, "type": "object" }, "Contract5": { "required": [ "label" ], "properties": { "contractMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractMetadata7" } }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "status": { "title": "Status of this contract", "type": "string" }, "label": { "title": "Label of this contract", "type": "string" } }, "type": "object" }, "Organization7": { "properties": { "contract": { "title": "contract as ID", "type": "string" }, "organizationType": { "title": "Organization type as ID", "type": "string" }, "id": { "title": "UUID of Organization", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "areas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Area12" } }, "organizationMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrganizationMetadata7" } }, "legalEntity": { "$ref": "#\/components\/schemas\/LegalEntity9" }, "label": { "title": "Label of this category", "type": "string" }, "status": { "title": "Status of that organization", "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category10" } }, "organizationMaster": { "title": "Organization master enabled or disabled", "type": "boolean" } }, "type": "object" }, "UserType": { "required": [ "id", "label" ], "properties": { "id": { "title": "Id of type, manualy generated", "type": "string" }, "label": { "title": "Label of type", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "UserType2": { "required": [ "id", "label" ], "properties": { "id": { "title": "Id of type, manualy generated", "type": "string" }, "label": { "title": "Label of type", "type": "string" } }, "type": "object" }, "UserType3": { "required": [ "id", "label" ], "properties": { "id": { "title": "Id of type, manualy generated", "type": "string" }, "label": { "title": "Label of type", "type": "string" } }, "type": "object" }, "AreaMetadata3": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "AreaMetadata4": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "AreaMetadata5": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "CategoryType": { "required": [ "code", "label" ], "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ClientMetadata3": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ClientMetadata4": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "ClientMetadata5": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "Area5": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "type": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractMetadata3": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Client4": { "required": [ "label" ], "properties": { "type": { "title": "client type as Id", "type": "string" }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label for this client", "type": "string" }, "departmentCode": { "title": "Department code", "type": "string" }, "description": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contracts": { "properties": { "href": { "type": "string" } }, "type": "object" }, "type": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractMetadata4": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "ContractMetadata5": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "ContractMetadata6": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Service5": { "required": [ "code", "label" ], "properties": { "categories": { "title": "Related categories' id.", "type": "array", "items": [ { "type": "string" } ] }, "serviceMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ServiceMetadata7" } }, "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Lable of service", "type": "string" }, "description": { "title": "Description of service", "type": "string" }, "enabled": { "title": "Service enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" }, "portal": { "$ref": "#\/components\/schemas\/Portal4" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "portal": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ServiceOption5": { "required": [ "code" ], "properties": { "code": { "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "type": "string" }, "description": { "type": "string" }, "enabled": { "title": "Service option enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service option", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ServiceOption6": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ServiceOption7": { "required": [ "code" ], "properties": { "code": { "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "type": "string" }, "description": { "type": "string" }, "enabled": { "title": "Service option enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service option", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntityMetadata3": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "legalEntity": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Client5": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contracts": { "properties": { "href": { "type": "string" } }, "type": "object" }, "type": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntityMetadata4": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "legalEntity": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Client6": { "required": [ "label" ], "properties": { "type": { "title": "client type as Id", "type": "string" }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label for this client", "type": "string" }, "departmentCode": { "title": "Department code", "type": "string" }, "description": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contracts": { "properties": { "href": { "type": "string" } }, "type": "object" }, "type": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntityMetadata5": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "LegalEntityMetadata6": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "Organization8": { "properties": { "contract": { "title": "contract as ID", "type": "string" }, "organizationType": { "title": "Organization type as ID", "type": "string" }, "id": { "title": "UUID of Organization", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "areas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Area13" } }, "organizationMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrganizationMetadata8" } }, "legalEntity": { "$ref": "#\/components\/schemas\/LegalEntity10" }, "label": { "title": "Label of this category", "type": "string" }, "status": { "title": "Status of that organization", "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category11" } }, "organizationMaster": { "title": "Organization master enabled or disabled", "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ContractService4": { "required": [ "service" ], "properties": { "contract": { "title": "Related contract as ID", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "contractServiceOptions": { "type": "string" }, "service": { "$ref": "#\/components\/schemas\/Service7" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Organization9": { "properties": { "contract": { "title": "contract as ID", "type": "string" }, "organizationType": { "title": "Organization type as ID", "type": "string" }, "id": { "title": "UUID of Organization", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "areas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Area14" } }, "organizationMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/OrganizationMetadata9" } }, "legalEntity": { "$ref": "#\/components\/schemas\/LegalEntity11" }, "label": { "title": "Label of this category", "type": "string" }, "status": { "title": "Status of that organization", "type": "string" }, "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category12" } }, "organizationMaster": { "title": "Organization master enabled or disabled", "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ContractService5": { "required": [ "service" ], "properties": { "contract": { "title": "Related contract as ID", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "contractServiceOptions": { "type": "string" }, "service": { "$ref": "#\/components\/schemas\/Service8" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Area6": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "type": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "OrganizationMetadata": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "organization": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntity5": { "required": [ "client" ], "properties": { "legalEntityMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/LegalEntityMetadata7" } }, "id": { "title": "UUID of Legal Entity", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "client": { "$ref": "#\/components\/schemas\/Client7" }, "label": { "title": "Label of this legal entity", "type": "string" }, "status": { "title": "Status of this legal entity", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "metadata": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Category4": { "properties": { "id": { "title": "UUID of Category", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label of this category", "type": "string" }, "externalId": { "title": "External Id of this category", "type": "string" }, "parentCategory": { "$ref": "#\/components\/schemas\/Category4" }, "active": { "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Area7": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" } }, "type": "object" }, "OrganizationMetadata2": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "Category5": { "properties": { "id": { "title": "UUID of Category", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label of this category", "type": "string" } }, "type": "object" }, "Area8": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "type": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "OrganizationMetadata3": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "organization": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntity6": { "required": [ "client" ], "properties": { "legalEntityMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/LegalEntityMetadata8" } }, "id": { "title": "UUID of Legal Entity", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "client": { "$ref": "#\/components\/schemas\/Client8" }, "label": { "title": "Label of this legal entity", "type": "string" }, "status": { "title": "Status of this legal entity", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "metadata": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Category6": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Area9": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" } }, "type": "object" }, "OrganizationMetadata4": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "Category7": { "properties": { "id": { "title": "UUID of Category", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label of this category", "type": "string" } }, "type": "object" }, "Area10": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "type": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "OrganizationMetadata5": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "organization": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntity7": { "required": [ "client" ], "properties": { "legalEntityMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/LegalEntityMetadata9" } }, "id": { "title": "UUID of Legal Entity", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "client": { "$ref": "#\/components\/schemas\/Client9" }, "label": { "title": "Label of this legal entity", "type": "string" }, "status": { "title": "Status of this legal entity", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "metadata": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Category8": { "properties": { "id": { "title": "UUID of Category", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label of this category", "type": "string" }, "externalId": { "title": "External Id of this category", "type": "string" }, "parentCategory": { "$ref": "#\/components\/schemas\/Category8" }, "active": { "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ServiceMetadata3": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Portal3": { "required": [ "code", "shortDescription" ], "properties": { "code": { "title": "Unique code of the portal", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "shortDescription": { "title": "Long description", "type": "string" }, "longDescription": { "title": "Short description", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "services": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ServiceMetadata4": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "ServiceMetadata5": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ServiceMetadata6": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "Service6": { "required": [ "code", "label" ], "properties": { "categories": { "title": "Related categories' id.", "type": "array", "items": [ { "type": "string" } ] }, "serviceMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ServiceMetadata8" } }, "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Lable of service", "type": "string" }, "description": { "title": "Description of service", "type": "string" }, "enabled": { "title": "Service enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" }, "serviceOptions": { "title": "Service's options", "type": "array", "items": { "$ref": "#\/components\/schemas\/ServiceOption" } }, "portal": { "$ref": "#\/components\/schemas\/Portal5" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "portal": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "UserMetadata3": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Contract6": { "required": [ "label" ], "properties": { "contractMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractMetadata8" } }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "status": { "title": "Status of this contract", "type": "string" }, "label": { "title": "Label of this contract", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractAreas": { "properties": { "href": { "type": "string" } }, "type": "object" }, "services": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractArea4": { "required": [ "area" ], "properties": { "contract": { "title": "contract as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "area": { "$ref": "#\/components\/schemas\/Area15" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ContractService6": { "required": [ "service" ], "properties": { "contract": { "title": "Related contract as ID", "type": "string" }, "service": { "$ref": "#\/components\/schemas\/Service9" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "contractServiceOptions": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractServiceOption6": { "required": [ "serviceOption" ], "properties": { "contractService": { "title": "Related contractService as Id", "type": "string" }, "serviceOption": { "$ref": "#\/components\/schemas\/ServiceOption8" }, "service": { "title": "Related service code", "type": "string" }, "contract": { "title": "Related contract as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "contractService": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "UserMetadata4": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "UserMetadata5": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" } }, "type": "object" }, "Contract7": { "required": [ "label" ], "properties": { "contractMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractMetadata9" } }, "id": { "title": "Id", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "status": { "title": "Status of this contract", "type": "string" }, "label": { "title": "Label of this contract", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractAreas": { "properties": { "href": { "type": "string" } }, "type": "object" }, "services": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractArea5": { "required": [ "area" ], "properties": { "contract": { "title": "contract as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "area": { "$ref": "#\/components\/schemas\/Area16" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "UserContractService5": { "properties": { "userContract": { "title": "Related user contract as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "contractServices": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractService6" }, "minItems": 1 }, "contractServiceOptions": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ContractServiceOption6" } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Area11": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "type": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "OrganizationMetadata6": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "organization": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntity8": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "metadata": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Category9": { "properties": { "id": { "title": "UUID of Category", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label of this category", "type": "string" }, "externalId": { "title": "External Id of this category", "type": "string" }, "parentCategory": { "$ref": "#\/components\/schemas\/Category9" }, "active": { "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Profile3": { "required": [ "code", "label" ], "properties": { "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Label of profile", "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Profile4": { "required": [ "code", "label" ], "properties": { "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Label of profile", "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "ContractMetadata7": { "type": "object" }, "Area12": { "type": "object" }, "OrganizationMetadata7": { "type": "object" }, "LegalEntity9": { "type": "object" }, "Category10": { "type": "object" }, "ServiceMetadata7": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Portal4": { "required": [ "code", "shortDescription" ], "properties": { "code": { "title": "Unique code of the portal", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "shortDescription": { "title": "Long description", "type": "string" }, "longDescription": { "title": "Short description", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "services": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Area13": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "type": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "OrganizationMetadata8": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "organization": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntity10": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "metadata": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Category11": { "properties": { "id": { "title": "UUID of Category", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label of this category", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Service7": { "properties": { "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category11" } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "portal": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Area14": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "type": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "OrganizationMetadata9": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "organization": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntity11": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "client": { "properties": { "href": { "type": "string" } }, "type": "object" }, "metadata": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Category12": { "properties": { "id": { "title": "UUID of Category", "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "title": "Label of this category", "type": "string" }, "externalId": { "title": "External Id of this category", "type": "string" }, "parentCategory": { "$ref": "#\/components\/schemas\/Category12" }, "active": { "type": "boolean" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Service8": { "properties": { "categories": { "type": "array", "items": { "$ref": "#\/components\/schemas\/Category12" } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "portal": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntityMetadata7": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "legalEntity": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Client7": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contracts": { "properties": { "href": { "type": "string" } }, "type": "object" }, "type": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntityMetadata8": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "legalEntity": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Client8": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contracts": { "properties": { "href": { "type": "string" } }, "type": "object" }, "type": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "LegalEntityMetadata9": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "legalEntity": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Client9": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contracts": { "properties": { "href": { "type": "string" } }, "type": "object" }, "type": { "properties": { "href": { "type": "string" } }, "type": "object" }, "areas": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ServiceMetadata8": { "properties": { "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Portal5": { "required": [ "code", "shortDescription" ], "properties": { "code": { "title": "Unique code of the portal", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "shortDescription": { "title": "Long description", "type": "string" }, "longDescription": { "title": "Short description", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "services": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractMetadata8": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Area15": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "type": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "Service9": { "required": [ "code", "label" ], "properties": { "categories": { "title": "Related categories' id.", "type": "array", "items": [ { "type": "string" } ] }, "portal": { "$ref": "#\/components\/schemas\/Portal6" }, "serviceMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/ServiceMetadata9" } }, "code": { "title": "Unique code of service", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "title": "Lable of service", "type": "string" }, "description": { "title": "Description of service", "type": "string" }, "enabled": { "title": "Service enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" }, "serviceOptions": { "title": "Service's options", "type": "array", "items": { "$ref": "#\/components\/schemas\/ServiceOption8" } }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "portal": { "properties": { "href": { "type": "string" } }, "type": "object" }, "contractServices": { "properties": { "href": { "type": "string" } }, "type": "object" }, "serviceOptions": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ServiceOption8": { "required": [ "code" ], "properties": { "service": { "$ref": "#\/components\/schemas\/Service9" }, "code": { "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "label": { "type": "string" }, "description": { "type": "string" }, "enabled": { "title": "Service option enabled or disabled", "type": "boolean" }, "type": { "title": "Type of service option", "type": "string" }, "iconCode": { "title": "Icon code", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "service": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ContractMetadata9": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Area16": { "properties": { "type": { "title": "user type as Id", "type": "string" }, "client": { "title": "client as Id", "type": "string" }, "areaMetadatas": { "type": "array", "items": { "$ref": "#\/components\/schemas\/AreaMetadata6" } }, "id": { "type": "string", "pattern": "^[0-9a-fA-F]{8}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{4}\\-[0-9a-fA-F]{12}$" }, "label": { "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "type": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "ServiceMetadata9": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" }, "Portal6": { "required": [ "code", "shortDescription" ], "properties": { "code": { "title": "Unique code of the portal", "type": "string", "pattern": "[A-Z][0-9A-Z_]*" }, "shortDescription": { "title": "Long description", "type": "string" }, "longDescription": { "title": "Short description", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" }, "_links": { "properties": { "self": { "properties": { "href": { "type": "string" } }, "type": "object" }, "services": { "properties": { "href": { "type": "string" } }, "type": "object" } }, "readOnly": true } }, "type": "object" }, "AreaMetadata6": { "required": [ "key" ], "properties": { "key": { "title": "Key name", "type": "string", "pattern": "[a-zA-Z][0-9A-Za-z_]*" }, "value": { "title": "Value as string", "type": "string" }, "createdBy": { "type": "string" }, "updatedBy": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "deletedAt": { "type": "string", "format": "date-time" } }, "type": "object" } }, "securitySchemes": { "apiToken": { "type": "apiKey", "description": "apiToken used to identify client", "name": "X-AUTH-TOKEN", "in": "header" } } }, "security": [ { "apiToken": [] } ], "tags": [ { "name": "areas", "description": "areas" }, { "name": "organization", "description": "organization" }, { "name": "areaMetadata", "description": "areaMetadata" }, { "name": "areaTypes", "description": "areaTypes" }, { "name": "category", "description": "category" }, { "name": "clients", "description": "clients" }, { "name": "clientMetadata", "description": "clientMetadata" }, { "name": "clientTypes", "description": "clientTypes" }, { "name": "contractAreas", "description": "contractAreas" }, { "name": "contracts", "description": "contracts" }, { "name": "contractMetadata", "description": "contractMetadata" }, { "name": "contractServices", "description": "contractServices" }, { "name": "contractServiceOptions", "description": "contractServiceOptions" }, { "name": "legalEntity", "description": "legalEntity" }, { "name": "legalEntityMetadata", "description": "legalEntityMetadata" }, { "name": "organizationContractService", "description": "organizationContractService" }, { "name": "organizationContractServiceOption", "description": "organizationContractServiceOption" }, { "name": "organizationType", "description": "organizationType" }, { "name": "portals", "description": "portals" }, { "name": "profile", "description": "profile" }, { "name": "services", "description": "services" }, { "name": "serviceMetadata", "description": "serviceMetadata" }, { "name": "serviceOptions", "description": "serviceOptions" }, { "name": "status", "description": "status" }, { "name": "UserConfigurations", "description": "UserConfigurations" }, { "name": "userConfigurations", "description": "userConfigurations" }, { "name": "userContracts", "description": "userContracts" }, { "name": "userContractServices", "description": "userContractServices" }, { "name": "users", "description": "users" }, { "name": "import", "description": "import" }, { "name": "userMetadata", "description": "userMetadata" }, { "name": "UserOrganization", "description": "UserOrganization" }, { "name": "UserProfile", "description": "UserProfile" }, { "name": "userTypes", "description": "userTypes" } ] }