2.0info: 0.2.0 xt_setup x-senior-domain: wms x-senior-domain-path: wms x-senior-service-path: xt_setup 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/wmssecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /xt_setup/queries/getTenantStatus: post: description: Retorna as informações do tenant com as informações passadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: cpf: type: string description: Cpf cnpj: type: string description: Cnpj responses: 200: description: Ok schema: type: object properties: status: type: string allOf: – #/definitions/enumStatusTenant description: Status do tenant default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do tenant com as informações passadas tags: – Queries x-senior-visibility: PRIVATE parameters: – name: cpf description: Cpf in: query type: string – name: cnpj description: Cnpj in: query type: string responses: 200: description: Ok schema: type: object properties: status: type: string allOf: – #/definitions/enumStatusTenant description: Status do tenant default: description: Error response schema: #/definitions/genericError /xt_setup/queries/getTenantStatusByName: post: description: Retorna as informações do tenant com o nome informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – name properties: name: type: string description: Nome do Tenant responses: 200: description: Ok schema: type: object properties: status: type: string allOf: – #/definitions/enumStatusTenant description: Status do tenant default: description: Error response schema: #/definitions/genericError get: description: Retorna as informações do tenant com o nome informado tags: – Queries x-senior-visibility: PRIVATE parameters: – name: name description: Nome do Tenant in: query required: true type: string responses: 200: description: Ok schema: type: object properties: status: type: string allOf: – #/definitions/enumStatusTenant description: Status do tenant default: description: Error response schema: #/definitions/genericError /xt_setup/queries/getTenantDomain: post: description: Retorna o dominio padrão do tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – tenantName – tenantDomain properties: tenantName: type: string description: Nome do Tenant tenantDomain: type: string description: Domínio do Tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o dominio padrão do tenant tags: – Queries x-senior-visibility: PRIVATE parameters: [] responses: 200: description: Ok schema: type: object required: – tenantName – tenantDomain properties: tenantName: type: string description: Nome do Tenant tenantDomain: type: string description: Domínio do Tenant 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_setup/queries/healthcheck: post: description: Verificação disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Verificação disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE parameters: [] responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do serviço checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verificações para assegurar o status 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_setup/queries/getWmsFrontendUrl: post: description: Retornar a URL do WMS Silt Onpremise tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retornar a URL do WMS Silt Onpremise tags: – Queries x-senior-visibility: PRIVATE parameters: [] responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_setup/queries/customMenu: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – server properties: server: type: string description: URL do Servidor WMS newWindow: type: boolean description: Abri nova janela default: false responses: 200: description: Ok schema: type: object required: – domain – service – description – menu properties: domain: type: string description: service: type: string description: description: type: string description: menu: type: string format: byte description: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: server description: URL do Servidor WMS in: query required: true type: string – name: newWindow description: Abri nova janela in: query type: boolean responses: 200: description: Ok schema: type: object required: – domain – service – description – menu properties: domain: type: string description: service: type: string description: description: type: string description: menu: type: string format: byte description: default: description: Error response schema: #/definitions/genericError /xt_setup/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 /xt_setup/queries/exportTenantInfos: 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 /xt_setup/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 /xt_setup/actions/createDefaultAppRole: post: description: Cria os papéis padrão para a aplicação. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: roleName: type: string description: Nome do papel responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_setup/actions/createTenant: post: description: Serviço para criar um tenant, em um primeiro momento é criada apenas uma conta temporária e somente após confirmar o email o tenant é criado. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – firstName – lastName – businessEmail – password – companyName – companyPhone – tenantDomain – createAccount properties: firstName: type: string description: Nome do usuário lastName: type: string description: Sobrenome do usuário businessEmail: type: string description: E-mail corporativo password: type: string description: Senha do usuário companyName: type: string maxLength: 80 description: Nome da empresa companyPhone: type: string maxLength: 25 description: Telefone da empresa cnpj: type: string description: Cadastro nacional da pessoa jurídica cpf: type: string description: Cadastro de pessoa física tenantDomain: type: string maxLength: 20 description: Domínio do tenant que será utilizado, se não for o mesmo que o domínio do e-mail do cadastro, será adicionado o sufixo .seniorx. locale: type: string description: Locale do navegador default: pt-BR baseUrl: type: string description: Base Url – Quando não informado será considerado: https://platform.senior.com.br createAccount: type: boolean description: Criar conta responses: 200: description: Ok schema: type: object default: description: Error response schema: #/definitions/genericError /xt_setup/actions/createUser: post: description: Cria um usuário associando um usuário WMS na plataforma tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – username – password – fullName – email properties: username: type: string description: Usuário login no wms password: type: string description: Senha fullName: type: string description: Nome Completo email: type: string description: E-Mail admin: type: boolean description: Administrador default: false responses: 200: description: Ok schema: type: object required: – username properties: username: type: string description: Nome do usuário recém associado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_setup/actions/assignUser: post: description: Associa um usuário WMS na plataforma para um usuário existente tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – username properties: username: type: string description: Usuário login no wms admin: type: boolean description: Administrador default: false responses: 200: description: Ok schema: type: object required: – username properties: username: type: string description: Nome do usuário recém associado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_setup/actions/importTenantInfos: 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 /xt_setup/events/importTenantInfosEvent: 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 /xt_setup/events/exportTenantInfosEvent: 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 /xt_setup/entities/tenantInfos: post: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tenantInfos responses: 200: description: The created resource schema: #/definitions/tenantInfos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tenantInfos responses: 200: description: The created resource schema: #/definitions/tenantInfos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tenantInfos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /xt_setup/entities/tenantInfos/{id}: put: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tenantInfos responses: 200: description: Ok schema: #/definitions/tenantInfos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError patch: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tenantInfos responses: 200: description: Ok schema: #/definitions/tenantInfos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tenantInfos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError delete: 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 /xt_setup/entities/tenantInfos/bulk: post: tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/tenantInfos responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError definitions: serviceHealthStatus: description: Define o Status do serviço type: string enum: – UP – DOWN enumStatusTenant: description: Situação do tenant type: string enum: – AGUARDANDO_ATIVACAO – ATIVADO – EXPIRADO 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 – 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 checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/serviceHealthStatus description: Status do healthcheck tenantInfos: description: Informações do tenant a ser criado type: object required: – firstName – lastName – businessEmail – companyName – companyPhone – tenantDomain – tenantName – locale – creationDate properties: id: type: string format: uuid description: Identificador único do registro firstName: type: string description: Nome do usuário lastName: type: string description: Sobrenome do usuário businessEmail: type: string description: E-mail corporativo companyName: type: string description: Nome da empresa companyPhone: type: string description: Telefone da empresa cnpj: type: string description: Cadastro nacional da pessoa jurídica cpf: type: string description: Cadastro de pessoa física tenantDomain: type: string maxLength: 255 description: Domínio do tenant que será utilizado, se não for o mesmo que o domínio do e-mail do cadastro, será adicionado o sufixo .seniorx. tenantName: type: string maxLength: 255 description: Nome do tenant locale: type: string description: Locale do navegador creationDate: type: string format: date-time description: Data de solicitação da criação do tenant status: type: string allOf: – #/definitions/enumStatusTenant description: Status do tenant createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: 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 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