2.0info: 1.0.3 hierarchy x-senior-domain: hcm x-senior-domain-path: hcm x-senior-service-path: hierarchy contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/hcmsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /hierarchy/queries/getSuperiorHierarchyItems: post: description: Busca as posições superiores da hierarquia os pares dos superiores e seus ocupantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – hierarchyId – employeeId properties: hierarchyId: type: string description: Hierarquia employeeId: type: string description: Colaborador responses: 200: description: Ok schema: type: object required: – superiorHierarchyItens properties: superiorHierarchyItens: type: array items: type: object allOf: – #/definitions/superiorHierarchyItemDTO minimum: 1 description: Posições superiores do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca as posições superiores da hierarquia os pares dos superiores e seus ocupantes tags: – Queries x-senior-visibility: PRIVATE parameters: – name: hierarchyId description: Hierarquia in: query required: true type: string – name: employeeId description: Colaborador in: query required: true type: string responses: 200: description: Ok schema: type: object required: – superiorHierarchyItens properties: superiorHierarchyItens: type: array items: type: object allOf: – #/definitions/superiorHierarchyItemDTO minimum: 1 description: Posições superiores do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/searchHierarchyItem: post: description: Realiza uma pesquisa de HierarchyItemDTO com base nos parâmetros de consulta fornecidos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – q – hierarchyId properties: q: type: string description: string de consulta a ser usada para corresponder a registros de HierarchyItemDTO hierarchyId: type: string description: O identificador da hierarquia a ser usado na pesquisa responses: 200: description: Ok schema: type: object required: – hierarchyItems properties: hierarchyItems: type: array items: type: object allOf: – #/definitions/hierarchyItemDTO minimum: 1 description: Lista de HierarchyItemDTO correspondentes à consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Realiza uma pesquisa de HierarchyItemDTO com base nos parâmetros de consulta fornecidos. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: q description: string de consulta a ser usada para corresponder a registros de HierarchyItemDTO in: query required: true type: string – name: hierarchyId description: O identificador da hierarquia a ser usado na pesquisa in: query required: true type: string responses: 200: description: Ok schema: type: object required: – hierarchyItems properties: hierarchyItems: type: array items: type: object allOf: – #/definitions/hierarchyItemDTO minimum: 1 description: Lista de HierarchyItemDTO correspondentes à consulta 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/getPairsAndSuperiorHierarchyItems: post: description: Busca itens da hierarquia associada ao coloaborador do contexto atual ou ao item de hierarquia passado por parâmetro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nhHierarchyId properties: nhHierarchyId: type: string description: Hierarquia hierarchyItemId: type: string description: Item da hierarquia responses: 200: description: Ok schema: type: object required: – hierarchyItems properties: hierarchyItems: type: array items: type: object allOf: – #/definitions/newHierarchyItemCardDTO minimum: 1 description: Itens da hierarquia relacionados ao item buscado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Busca itens da hierarquia associada ao coloaborador do contexto atual ou ao item de hierarquia passado por parâmetro tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nhHierarchyId description: Hierarquia in: query required: true type: string – name: hierarchyItemId description: Item da hierarquia in: query type: string responses: 200: description: Ok schema: type: object required: – hierarchyItems properties: hierarchyItems: type: array items: type: object allOf: – #/definitions/newHierarchyItemCardDTO minimum: 1 description: Itens da hierarquia relacionados ao item buscado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/getChildrenHierarchyItems: post: description: API utilizada para montar a árvore da tela de hierarquia, começando pela posição passada por parâmetro e subindo os nós da árvore até a sua raíz tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – nhHierarchyId – parentHierarchyItem properties: nhHierarchyId: type: string description: Hierarquia parentHierarchyItem: type: string description: Item da hierarquia responses: 200: description: Ok schema: type: object required: – hierarchyItems properties: hierarchyItems: type: array items: type: object allOf: – #/definitions/newHierarchyItemCardDTO minimum: 1 description: Itens da hierarquia relacionados ao item buscado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: API utilizada para montar a árvore da tela de hierarquia, começando pela posição passada por parâmetro e subindo os nós da árvore até a sua raíz tags: – Queries x-senior-visibility: PRIVATE parameters: – name: nhHierarchyId description: Hierarquia in: query required: true type: string – name: parentHierarchyItem description: Item da hierarquia in: query required: true type: string responses: 200: description: Ok schema: type: object required: – hierarchyItems properties: hierarchyItems: type: array items: type: object allOf: – #/definitions/newHierarchyItemCardDTO minimum: 1 description: Itens da hierarquia relacionados ao item buscado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/getWorkstationGroupPriorityEmployee: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – workstationGroups properties: workstationGroups: type: array items: type: object allOf: – #/definitions/WorkstationGroupKey minimum: 1 description: Postos de trabalho (chaves XT) responses: 200: description: Ok schema: type: object required: – workstationGroupPriorityEmployee properties: workstationGroupPriorityEmployee: type: array items: type: object allOf: – #/definitions/WorkstationGroupPriorityEmployeeDTO minimum: 1 description: Lista de postos de trabalho com seu colaborador prioritário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/getAllHierarquiesByEmployee: post: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hierarchies properties: hierarchies: type: array items: type: object allOf: – #/definitions/nhHierarchy minimum: 1 description: Lista de hierarquias do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – hierarchies properties: hierarchies: type: array items: type: object allOf: – #/definitions/nhHierarchy minimum: 1 description: Lista de hierarquias do colaborador 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/getMetadata: post: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: metadataFormat: type: string description: responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Default getMetadata query. Every service must handle this command and return metadata in the format requested. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataFormat description: in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportNhHierarchy: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportWorkstationGroupStructure: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportNhHierarchyType: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportNhHierarchyRevision: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportNhHierarchyItem: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportWorkstationGroup: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportHierarchy: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportHierarchyItem: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportCompanyHierarchy: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportWorkstation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportHistoricalWorkstation: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportActingType: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportCompany: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportEmployee: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportJobPosition: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportHistoricalJobPosition: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportPerson: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportAttachment: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportPriorityWorkstationGroupOccupants: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/exportTenantSetting: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/exportConfig description: responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/queries/healthcheck: post: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: HealthCheck plataforma tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status de retorno checks: type: object allOf: – #/definitions/checkDTO description: Checks executados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/savePriorityWorkstationGroupOccupants: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – workstationGroupId – priorityWorkstationGroupOccupants properties: workstationGroupId: type: string description: Id do posto de trabalho priorityWorkstationGroupOccupants: type: array items: type: object allOf: – #/definitions/priorityWorkstationGroupOccupantsNoWorkstationGroupDTO minimum: 1 description: Lista de prioridades dos ocupantes do posto responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importNhHierarchy: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importWorkstationGroupStructure: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importNhHierarchyType: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importNhHierarchyRevision: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importNhHierarchyItem: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importWorkstationGroup: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importHierarchy: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importHierarchyItem: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importCompanyHierarchy: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importWorkstation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importHistoricalWorkstation: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importActingType: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importCompany: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importEmployee: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importJobPosition: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importHistoricalJobPosition: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importPerson: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importAttachment: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importPriorityWorkstationGroupOccupants: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/actions/importTenantSetting: post: description: tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – config properties: config: type: object allOf: – #/definitions/importConfig description: responses: 200: description: Ok schema: type: object required: – importJobId properties: importJobId: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/events/importNhHierarchyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportNhHierarchyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importWorkstationGroupStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportWorkstationGroupStructureEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importNhHierarchyTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportNhHierarchyTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importNhHierarchyRevisionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportNhHierarchyRevisionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importNhHierarchyItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportNhHierarchyItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importWorkstationGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportWorkstationGroupEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importHierarchyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportHierarchyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importHierarchyItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportHierarchyItemEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importCompanyHierarchyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportCompanyHierarchyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importWorkstationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportWorkstationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importHistoricalWorkstationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportHistoricalWorkstationEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importActingTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportActingTypeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportCompanyEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportEmployeeEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importJobPositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportJobPositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importHistoricalJobPositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportHistoricalJobPositionEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importPersonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportPersonEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importAttachmentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportAttachmentEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importPriorityWorkstationGroupOccupantsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportPriorityWorkstationGroupOccupantsEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/importTenantSettingEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/importEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/events/exportTenantSettingEvent: post: description: x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – eventpl properties: eventpl: type: object allOf: – #/definitions/exportEventStatus description: responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /hierarchy/entities/nhHierarchy: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/nhHierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/workstationGroupStructure: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/workstationGroupStructure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/nhHierarchyType: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/nhHierarchyType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/nhHierarchyRevision: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/nhHierarchyRevision 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/nhHierarchyItem: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/nhHierarchyItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/workstationGroup: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/workstationGroup 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/hierarchy: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/hierarchyItem: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/hierarchyItem 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/companyHierarchy: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/companyHierarchy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/workstation: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/workstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/historicalWorkstation: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/historicalWorkstation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/actingType: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/actingType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/company: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/company 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/employee: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/employee 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/jobPosition: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/jobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/historicalJobPosition: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/historicalJobPosition 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/person: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/person 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/attachment: get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/attachment 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/priorityWorkstationGroupOccupants: post: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/priorityWorkstationGroupOccupants responses: 200: description: The created resource schema: #/definitions/priorityWorkstationGroupOccupants 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/priorityWorkstationGroupOccupants responses: 200: description: The created resource schema: #/definitions/priorityWorkstationGroupOccupants 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number – name: filter in: query type: string – name: groupby in: query type: string – name: displayfields in: query type: string – name: translation in: query type: boolean responses: 200: description: Ok schema: type: array items: #/definitions/priorityWorkstationGroupOccupants 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/priorityWorkstationGroupOccupants/{id}: put: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/priorityWorkstationGroupOccupants responses: 200: description: Ok schema: #/definitions/priorityWorkstationGroupOccupants 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/priorityWorkstationGroupOccupants responses: 200: description: Ok schema: #/definitions/priorityWorkstationGroupOccupants 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/priorityWorkstationGroupOccupants 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: description: Esta entidade pode ser customizada. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /hierarchy/entities/priorityWorkstationGroupOccupants/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/priorityWorkstationGroupOccupants responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: hierarchyStatus: description: Status da hierarquia type: string enum: – PROCESSING – WAITINGINTEGRATION – INTEGRATED – ERROR – DEPRECATED userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – LOCALDATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR healthcheckDTO: description: Status do healthcheck type: string enum: – UP – DOWN superiorHierarchyItemDTO: description: type: object required: – hierarchyItemId – parentItemId – workstationGroupDTO – treeLevel – occupants properties: hierarchyItemId: type: string description: Item da hierarquia parentItemId: type: string description: Item superior da posição workstationGroupDTO: type: object allOf: – #/definitions/workstationGroupDTO description: Posto de trabalho da posição treeLevel: type: integer format: int64 description: Nível da posição occupants: type: array items: type: object allOf: – #/definitions/positionOccupantDTO minimum: 1 description: Ocupantes da posição priorityWorkstationGroupOccupantsNoWorkstationGroupDTO: description: type: object required: – employeeId – sequence properties: employeeId: type: string description: Id do colaborador sequence: type: integer format: int64 description: Sequência workstationGroupDTO: description: type: object required: – id – name – workstationGroupCode properties: id: type: string description: Identificador name: type: string description: Nome do posto workstationGroupCode: type: string description: Código do posto positionOccupantDTO: description: type: object required: – personId – employeeId – employeeRegisterNumber – personName – photoLink – jobPositionName – workstationGroupDateWhen – userName – employeePriority properties: personId: type: string description: Identificador da pessoa employeeId: type: string description: Identificador do colaborador employeeRegisterNumber: type: integer format: int64 description: Matrícula do colaborador personName: type: string description: Nome da pessoa photoLink: type: string description: Link da imagem da foto da pessoa jobPositionName: type: string description: Nome do cargo workstationGroupDateWhen: type: string format: date description: Data inicial do posto atual do colaborador userName: type: string description: Login do usuário employeePriority: type: integer format: int64 description: Prioridade do ocupante na posição hierarchyItemDTO: description: DTO principal para comunicação do posto de um colaborador type: object required: – hierarchyItemId – workstationGroupName – jobPositionName – personName – photoLink – personId properties: hierarchyItemId: type: string description: Identificador do item de hierarquia workstationGroupName: type: string description: Nome do posto jobPositionName: type: string description: Nome do cargo personName: type: string description: Nome da pessoa photoLink: type: string description: Link da foto do colaborador personId: type: string description: Identificador da pessoa newHierarchyItemCardDTO: description: type: object required: – hierarchyItemId – hierarchyItemParentId – workstationGroup – treeLevel – occupants – hasChildren properties: hierarchyItemId: type: string description: Id deste ítem de hierarquia hierarchyItemParentId: type: string description: Id da posição superior workstationGroup: type: object allOf: – #/definitions/workstationGroupDTO description: Posto de trabalho associado a este ítem de hierarquia treeLevel: type: integer format: int64 description: Nível do ítem na hierarquia occupants: type: array items: type: object allOf: – #/definitions/newHierarchyItemCardOccupantDTO minimum: 1 description: Ocupantes do posto hasChildren: type: boolean description: Indica se o item possui filhos newHierarchyItemCardOccupantDTO: description: type: object required: – personId – employeeId – employeeRegisterNumber – personName – photoLink – jobPositionName – workstationGroupDateWhen – username – occupantPriority properties: personId: type: string description: Id da pessoa employeeId: type: string description: Id do colaborador employeeRegisterNumber: type: integer format: int64 description: Matrícula do colaborador personName: type: string description: Nome da pessoa photoLink: type: string description: Link da imagem da foto da pessoa jobPositionName: type: string description: Nome do cargo workstationGroupDateWhen: type: string format: date description: Data inicial do posto atual do colaborador username: type: string description: Utilizado para gerar o link para o perfil da pessoa occupantPriority: type: integer format: int64 description: Prioridade do colaborador para montagem da hierarquia padrão occupantDTO: description: type: object required: – position – person – employeeId – employeeRegisterNumber – jobPositionName – workstationGroupDateWhen – occupantPriority – hasChildren properties: position: type: object allOf: – #/definitions/positionDTO description: person: type: object allOf: – #/definitions/personDTO description: employeeId: type: string description: employeeRegisterNumber: type: integer format: int64 description: jobPositionName: type: string description: workstationGroupDateWhen: type: string format: date description: occupantPriority: type: integer format: int64 description: hasChildren: type: boolean description: positionDTO: description: type: object required: – hierarchyItemId – parentItemId – workstationGroup – treeLevel properties: hierarchyItemId: type: string description: parentItemId: type: string description: workstationGroup: type: object allOf: – #/definitions/workstationGroupDTO description: treeLevel: type: integer format: int64 description: personDTO: description: type: object required: – personId – fullName – username – attachment properties: personId: type: string description: fullName: type: string description: username: type: string description: attachment: type: string description: WorkstationGroupKey: description: Chaves de um posto de trabalho do XT type: object required: – workstationGroupStructureCode – workstationGroupCode properties: workstationGroupStructureCode: type: integer format: int64 description: Código da estrutura de postos workstationGroupCode: type: string description: Código do posto de trabalho WorkstationGroupPriorityEmployeeDTO: description: Colaborador prioritário de um posto type: object required: – workstationGroupStructureCode – workstationGroupCode – companyNumber – employeeType – employeeRegisterNumber properties: workstationGroupStructureCode: type: integer format: int64 description: Código da estrutura de postos workstationGroupCode: type: string description: Código do posto de trabalho companyNumber: type: integer format: int64 description: Empresa do colabordor prioritário employeeType: type: integer format: int64 description: Tipo do colabordor prioritário employeeRegisterNumber: type: integer format: int64 description: Matrícula do colabordor prioritário nhHierarchy: description: Hierarquia Beta type: object required: – workstationGroupStructure – hierarchyType – createdDate – lastModifiedDate – externalId properties: id: type: string maxLength: 32 description: Id da hierarquia workstationGroupStructure: type: object allOf: – #/definitions/workstationGroupStructure description: Estrutura de postos hierarchyType: type: object allOf: – #/definitions/nhHierarchyType description: Tipo de hierarquia createdDate: type: string format: date-time description: Data de criação lastModifiedDate: type: string format: date-time description: Última data de modificação externalId: type: string description: Id externo workstationGroupStructure: description: Estrutura de postos type: object required: – name – code properties: id: type: string maxLength: 32 description: Id da estrutura name: type: string description: Nome da estrutura de postos code: type: integer format: int64 description: Código da estrutura de posto de trabalho – ESTPOS nhHierarchyType: description: Tipo de hierarquia beta type: object required: – code – description – createdDate – lastModifiedDate – externalId properties: id: type: string maxLength: 32 description: Id da hierarquia code: type: integer format: int64 description: Código do tipo de hierarquia description: type: string maxLength: 255 description: Nome do tipo de hierarquia observation: type: string description: Observações createdDate: type: string format: date-time description: Data de criação lastModifiedDate: type: string format: date-time description: Última data de modificação externalId: type: string description: Id externo nhHierarchyRevision: description: Revisão da hierarquia beta type: object required: – hierarchy – startDate – endDate – createdDate – lastModifiedDate – externalId properties: id: type: string maxLength: 32 description: Id da revisão hierarchy: type: object allOf: – #/definitions/nhHierarchy description: Hierarquia beta startDate: type: string format: date description: Data de início endDate: type: string format: date description: Data de fim observation: type: string description: Observações createdDate: type: string format: date-time description: Data de criação lastModifiedDate: type: string format: date-time description: Última data de modificação externalId: type: string description: Id externo nhHierarchyItem: description: Itens da hierarquia beta type: object required: – hierarchyRevision – workstationGroup – hierarchicalPosition – treeLevel – children – externalId properties: id: type: string maxLength: 32 description: Id do item hierarchyRevision: type: object allOf: – #/definitions/nhHierarchyRevision description: Id da revisão workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Grupo de postos hierarchicalPosition: type: string description: Posição hierárquica treeLevel: type: integer format: int64 description: Nível da árvore parentPosition: type: object allOf: – #/definitions/nhHierarchyItem description: Pai do item children: type: array items: type: object allOf: – #/definitions/nhHierarchyItem minimum: 1 description: Filhos do item externalId: type: string description: Id externo workstationGroup: description: Posto de trabalho type: object required: – name – workstationGroupStructure – code – creationDate – expirationDate properties: id: type: string maxLength: 32 description: Id do grupo de postos name: type: string maxLength: 255 description: Nome do grupo de postos workstationGroupStructure: type: object allOf: – #/definitions/workstationGroupStructure description: Grupo da estrutura de postos code: type: string maxLength: 32 description: Códido do grupo de postos creationDate: type: string format: date description: Data de criação do posto expirationDate: type: string format: date description: Data de expiração do posto hierarchy: description: Hierarquia padrão type: object required: – description – name – lastUpdate – externalId properties: id: type: string maxLength: 32 description: Id da hierarquia description: type: string maxLength: 255 description: Descrição da hierarquia name: type: string maxLength: 255 description: Nome da hierarquia lastUpdate: type: string format: date-time description: Data da última modificação externalId: type: string description: Id externo hierarchyItem: description: Item da hierarquia padrão type: object required: – hierarchy – workstation – position properties: id: type: string maxLength: 32 description: Id do item hierarchy: type: object allOf: – #/definitions/hierarchy description: Hierarquia workstation: type: object allOf: – #/definitions/workstation description: Posto de trabalho parent: type: object allOf: – #/definitions/hierarchyItem description: Pai do item position: type: string maxLength: 500 description: Posição hierárquica companyHierarchy: description: Hierarquia da empresa type: object required: – company – hierarchy – startDate properties: id: type: string maxLength: 32 description: Id da hierarquia company: type: object allOf: – #/definitions/company description: Empresa hierarchy: type: object allOf: – #/definitions/hierarchy description: Hierarquia startDate: type: string format: date description: Data de início workstation: description: Histórico do posto de trabalho type: object required: – company – occupant – workstationGroup properties: id: type: string maxLength: 32 description: Id do posto company: type: object allOf: – #/definitions/company description: Empresa occupant: type: object allOf: – #/definitions/employee description: Ocupante do posto workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Grupo do posto historicalWorkstation: description: Histórico de posto type: object required: – dateWhen – employee – workstationGroup – actingType – endDate properties: id: type: string maxLength: 32 description: Id do histórico dateWhen: type: string format: date description: Data de início employee: type: object allOf: – #/definitions/employee description: Colaborador workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Posto actingType: type: object allOf: – #/definitions/actingType description: Tipo de atuação endDate: type: string format: date description: Término do posto actingType: description: Tipo de atuação type: object required: – code – description – mainHistory properties: id: type: string maxLength: 32 description: Id do tipo de atuação code: type: integer format: int64 description: Código description: type: string maxLength: 40 description: Descrição do tipo de atuação mainHistory: type: boolean description: Histórico principal company: description: Empresa type: object required: – companyName – tradingName – code properties: id: type: string maxLength: 32 description: Id da empresa companyName: type: string maxLength: 255 description: Nome da empresa tradingName: type: string maxLength: 40 description: Nome fantasia code: type: integer format: int64 description: Código da empresa headquarter: type: object allOf: – #/definitions/company description: Matriz employee: description: Colaborador type: object required: – employer – hireDate – jobPosition – person – companyNumber – registerNumber – employeeType properties: id: type: string maxLength: 32 description: Id do colaborador employer: type: object allOf: – #/definitions/company description: Empresa hireDate: type: string format: date description: Data de contratação jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo person: type: object allOf: – #/definitions/person description: Pessoa dismissalDate: type: string format: date description: Data de demissão companyNumber: type: integer format: int64 description: Número da empresa registerNumber: type: integer format: int64 description: Número de matrícula employeeType: type: integer format: int64 description: Tipo de colaborador jobPosition: description: Cargo type: object required: – name – code properties: id: type: string maxLength: 32 description: Id do cargo name: type: string maxLength: 255 description: Nome do cargo code: type: string maxLength: 32 description: Código do cargo historicalJobPosition: description: Histórico de cargo type: object required: – dateWhen – employee – jobPosition properties: id: type: string maxLength: 32 description: Id do histórico dateWhen: type: string format: date description: Data de início employee: type: object allOf: – #/definitions/employee description: Colaborador jobPosition: type: object allOf: – #/definitions/jobPosition description: Cargo endDate: type: string format: date description: Data de término person: description: Pessoa type: object required: – firstName – middleName – lastName – fullName – username – attachment properties: id: type: string maxLength: 32 description: Id da pessoa firstName: type: string description: Primeiro nome middleName: type: string description: Nome do meio lastName: type: string description: Último nome fullName: type: string description: Nome da pessoa username: type: string description: Usuário attachment: type: string description: Foto de perfil da pessoa attachment: description: Anexos type: object required: – name properties: id: type: string maxLength: 32 description: Id do anexo name: type: string description: Nome do anexo priorityWorkstationGroupOccupants: description: Prioridade dos ocupantes do posto type: object required: – workstationGroup – employee – sequence properties: id: type: string format: uuid description: Id da prioridade workstationGroup: type: object allOf: – #/definitions/workstationGroup description: Posto de trabalho employee: type: object allOf: – #/definitions/employee description: Colaborador sequence: type: integer format: int64 description: Sequência tenantSetting: description: type: object required: – id – restrictEmployeeByCompany properties: id: type: string description: Identificador restrictEmployeeByCompany: type: boolean description: Restringe colaborador por empresa notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service checkDTO: description: Retorno status usados de retorno type: object required: – status – name properties: status: type: string allOf: – #/definitions/healthcheckDTO description: Status name: type: string description: Status genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE