Mais pesquisados:Customização, Tutorial, Documentação

backend

250 views 0 22/10/2018 Atualizado em 07/10/2024 integrador

2.0info: 10.1.0 backend x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: backend contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /backend/queries/healthcheck: post: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query para o SRE verificar a disponibilidade do serviço tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/healthCheckStatus description: Status do serviços checks: type: array items: type: object allOf: – #/definitions/checkDTO minimum: 1 description: Items avaliados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/queries/getLauncherConfiguration: post: description: Retorna a configuração do launcher tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – port – ssl – keyPassword – jnlp – testUrl – urlDownload properties: port: type: integer format: int64 description: Porta que o server será exposto ssl: type: boolean description: Define se o launcher deve ser exposto com SSL keyPassword: type: string description: Password da geração da aplicação WebStart jnlp: type: string description: Conteúdo para o arquivo JNLP conforme configuração testUrl: type: string description: URL para testar a conexão com o launcher local urlDownload: type: string description: URL para download que será aplicado no JNLP proxy: type: object allOf: – #/definitions/proxyConfigDef description: Configuração do proxy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna a configuração do launcher tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – port – ssl – keyPassword – jnlp – testUrl – urlDownload properties: port: type: integer format: int64 description: Porta que o server será exposto ssl: type: boolean description: Define se o launcher deve ser exposto com SSL keyPassword: type: string description: Password da geração da aplicação WebStart jnlp: type: string description: Conteúdo para o arquivo JNLP conforme configuração testUrl: type: string description: URL para testar a conexão com o launcher local urlDownload: type: string description: URL para download que será aplicado no JNLP proxy: type: object allOf: – #/definitions/proxyConfigDef description: Configuração do proxy 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/queries/getLauncherProperties: post: description: Lista todas as propriedades do launcher tags: – Queries x-senior-visibility: PRIVATE parameters: responses: 200: description: Ok schema: type: object required: – properties properties: properties: type: array items: type: object allOf: – #/definitions/fullLauncherPropertyDef minimum: 1 description: lista de propriedades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todas as propriedades do launcher tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – properties properties: properties: type: array items: type: object allOf: – #/definitions/fullLauncherPropertyDef minimum: 1 description: lista de propriedades 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/queries/getCurrentCSS: post: description: Obtém o CSS atual. O tenant é obtido através do token de autenticação. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – CSSURL properties: CSSURL: type: string description: URL do CSS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o CSS atual. O tenant é obtido através do token de autenticação. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – CSSURL properties: CSSURL: type: string description: URL do CSS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/queries/getCurrentCSSforTenant: post: description: Obtém o CSS atual para um determinado tenant. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – tenant properties: tenant: type: string description: Contém o nome do tenant responses: 200: description: Ok schema: type: object required: – CSSURL properties: CSSURL: type: string description: URL do CSS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Obtém o CSS atual para um determinado tenant. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Contém o nome do tenant in: query required: true type: string responses: 200: description: Ok schema: type: object required: – CSSURL properties: CSSURL: type: string description: URL do CSS 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/queries/listAllLandPages: post: description: Retorna uma lista com todas as landpages cadastradas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – landpages properties: landpages: type: array items: type: object allOf: – #/definitions/fullLandPageDef minimum: 1 description: A lista com todas as landpages cadastradas. Requer permissão para isso. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma lista com todas as landpages cadastradas tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – landpages properties: landpages: type: array items: type: object allOf: – #/definitions/fullLandPageDef minimum: 1 description: A lista com todas as landpages cadastradas. Requer permissão para isso. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/queries/getLandPageById: post: description: Retorna uma landpage específica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – landpageId properties: landpageId: type: string description: Identificador da Landpage responses: 200: description: Ok schema: type: object properties: landpage: type: object allOf: – #/definitions/fullLandPageDef description: A landpage, ou null se não existir 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna uma landpage específica tags: – Queries x-senior-visibility: PRIVATE parameters: – name: landpageId description: Identificador da Landpage in: query required: true type: string responses: 200: description: Ok schema: type: object properties: landpage: type: object allOf: – #/definitions/fullLandPageDef description: A landpage, ou null se não existir 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/queries/listUserLandPages: post: description: Retorna as landpages associadas ao usuário logado. Pode haver mais de uma, pois ele pode estar associado a mais de um papel, cada um com a sua landpage.\n Se o usuário não estiver associado (via papel) a nenhuma landpage, será retornada a landpage padrão.\n Caso não exista nenhuma landpage padrão definida, será retornado um array vazio tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – landpages properties: landpages: type: array items: type: object allOf: – #/definitions/landPageDef minimum: 1 description: A lista com todas as landpages do usuário logado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna as landpages associadas ao usuário logado. Pode haver mais de uma, pois ele pode estar associado a mais de um papel, cada um com a sua landpage.\n Se o usuário não estiver associado (via papel) a nenhuma landpage, será retornada a landpage padrão.\n Caso não exista nenhuma landpage padrão definida, será retornado um array vazio tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object required: – landpages properties: landpages: type: array items: type: object allOf: – #/definitions/landPageDef minimum: 1 description: A lista com todas as landpages do usuário logado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/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 /backend/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC 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: PUBLIC 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 /backend/actions/configureLauncher: post: description: Configura o launcher tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – ssl properties: port: type: integer format: int64 description: Porta que o server será exposto ssl: type: boolean description: Define se o launcher deve ser exposto com SSL keyPassword: type: string description: Password da geração da aplicação WebStart urlDownload: type: string description: URL para download que será aplicado no JNLP proxy: type: object allOf: – #/definitions/proxyConfigDef description: Configuração do proxy responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/actions/addLauncherProperty: post: description: Adiciona uma propriedade do launcher tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – property properties: property: type: object allOf: – #/definitions/addLauncherPropertyDef description: responses: 200: description: Ok schema: type: object required: – id properties: id: type: string description: Id do registro criado 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/actions/updateLauncherProperty: post: description: Atualiza uma propriedade do launcher tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – property properties: property: type: object allOf: – #/definitions/updateLauncherPropertyDef description: responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/actions/removeLauncherProperty: post: description: Remove uma propriedade do launcher tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – propertyId properties: propertyId: type: string description: Id da property responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/actions/insertLandPage: post: description: Insere uma nova definição de landpage tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – title – type – urls properties: type: string description: Título da landpage type: type: string allOf: – #/definitions/landpageTypeEnum description: Indica o tipo de landpage urls: type: array items: type: string minimum: 1 description: Contém a lista com as URLs que serão exibidas na landpage leftWidthPercent: type: integer format: int64 description: Contém o percentual da tela que a coluna da esquerda ocupa, somente para o tipo flow. Deve estar entre 0 e 100. withCredentials: type: boolean description: Indica se devem ser enviadas as credências para as páginas da landpage default: false roles: type: array items: type: string description: Contém uma lista com os ids do papel que esta landpage está associada defaultPage: type: boolean description: Indica se esta landpage é a padrão, que é utilizada caso o papel não esteja com nenhuma landpage associada, se não for passado é false responses: 200: description: Ok schema: type: object required: – landpageId properties: landpageId: type: string description: Identificador da land page 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/actions/removeLandPage: post: description: Apaga uma definição de landpage tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – landpageId properties: landpageId: type: string description: Identificador da land page responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/actions/updateLandPage: post: description: Atualiza uma definição de landpage tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – landpageId – title – type – urls properties: landpageId: type: string description: Identificador da land page type: string description: Título da landpage type: type: string allOf: – #/definitions/landpageTypeEnum description: Indica o tipo de landpage urls: type: array items: type: string minimum: 1 description: Contém a lista com as URLs que serão exibidas na landpage leftWidthPercent: type: integer format: int64 description: Contém o percentual da tela que a coluna da esquerda ocupa, somente para o tipo flow. Deve estar entre 0 e 100. withCredentials: type: boolean description: Indica se devem ser enviadas as credências para as páginas da landpage default: false roles: type: array items: type: string description: Contém uma lista com os ids do papel que esta landpage está associada defaultPage: type: boolean description: Indica se esta landpage é a padrão, que é utilizada caso o papel não esteja com nenhuma landpage associada, se não for passado é false responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/actions/setLandPagesOrder: post: description: Altera a ordem das land pages tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – landPagesId properties: landPagesId: type: array items: type: string minimum: 1 description: Id das land pages na ordem que elas devem ser apresentadas responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Boolean indicando o sucesso da operação 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/actions/postFeedback: post: description: Salva um feedback sobre a plataforma tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – comment properties: comment: type: string description: Feedback do usuário responses: 200: description: Ok schema: type: object required: – ok properties: ok: type: boolean description: Indica se o feedback foi salvo com sucesso 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /backend/signals/addLauncherMenuItem: post: description: Adiciona um item de menu para um aplicativo do Launcher, ao final do processamento é enviado uma notificação ao usuário informando-o se foi adicionado com sucesso ou se aconteceu algum problema. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – launcherId – menuItemId – label properties: launcherId: type: string description: Identificador do aplicativo criado para o Launcher menuItemId: type: string description: Identificador do item de menu que deve ser associado ao aplicativo label: type: string description: Rótulo do menu do aplicativo do launcher responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /backend/signals/updateLauncherMenuItem: post: description: Atualiza um item de menu para um aplicativo do Launcher, ao final do processamento é enviado uma notificação ao usuário informando-o se foi atualizado com sucesso ou se aconteceu algum problema. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – launcherId – menuItemId – label properties: launcherId: type: string description: Identificador do aplicativo criado para o Launcher menuItemId: type: string description: Identificador do item de menu que deve ser associado ao aplicativo label: type: string description: Rótulo do menu do aplicativo do launcher responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /backend/signals/removeLauncherMenuItem: post: description: Remove um item de menu para o aplicativo do Launcher, ao final do processamento é enviado uma notificação ao usuário informando-o se foi removido com sucesso ou se aconteceu algum problema. tags: – Signals parameters: – name: input in: body required: true schema: type: object required: – launcherId – menuItemId properties: launcherId: type: string description: Identificador do aplicativo criado para o Launcher menuItemId: type: string description: Identificador do item de menu que deve ser associado ao aplicativo responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError definitions: healthCheckStatus: description: Status do Healthcheck type: string enum: – UP – DOWN landpageTypeEnum: description: type: string enum: – List – Grid – Flow 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 checkDTO: description: Componente avaliado no health check type: object required: – name – status properties: name: type: string description: Nome do componente status: type: string allOf: – #/definitions/healthCheckStatus description: Status do componente landPageDef: description: type: object required: – landpageId – title – type – urls – withCredentials properties: landpageId: type: string description: Identificador da land page type: string description: Título da landpage type: type: string allOf: – #/definitions/landpageTypeEnum description: Indica o tipo de landpage urls: type: array items: type: string minimum: 1 description: Contém a lista com as URLs que serão exibidas na landpage leftWidthPercent: type: integer format: int64 description: Contém o percentual da tela que a coluna da esquerda ocupa, somente para o tipo flow. Deve estar entre 0 e 100. withCredentials: type: boolean description: Indica se devem ser enviadas as credências para as páginas da landpage fullLandPageDef: description: type: object required: – landpageId – title – type – urls – withCredentials properties: landpageId: type: string description: Identificador da land page type: string description: Título da landpage type: type: string allOf: – #/definitions/landpageTypeEnum description: Indica o tipo de landpage urls: type: array items: type: string minimum: 1 description: Contém a lista com as URLs que serão exibidas na landpage leftWidthPercent: type: integer format: int64 description: Contém o percentual da tela que a coluna da esquerda ocupa, somente para o tipo flow. Deve estar entre 0 e 100. roles: type: array items: type: string description: Contém uma lista com os ids do papel que esta landpage está associada defaultPage: type: boolean description: Indica se esta landpage é a padrão, que é utilizada caso o papel não esteja com nenhuma landpage associada, se não for passado é false withCredentials: type: boolean description: Indica se devem ser enviadas as credências para as páginas da landpage addLauncherPropertyDef: description: type: object required: – name – content properties: name: type: string description: Nome da proprtie content: type: string description: Valor da propriedade parameter: type: string description: Parâmetro para execução do aplicativo pelo launcher updateLauncherPropertyDef: description: type: object required: – propertyId – name – content properties: propertyId: type: string description: Identificador da propertie name: type: string description: Nome da proprtie content: type: string description: Valor da propriedade parameter: type: string description: Parâmetro para execução do aplicativo pelo launcher fullLauncherPropertyDef: description: type: object required: – propertyId – name – content properties: propertyId: type: string description: Identificador da propertie name: type: string description: Nome da proprtie content: type: string description: Valor da propriedade parameter: type: string description: Parâmetro para execução do aplicativo pelo launcher menuId: type: string description: Identificador do menu do launcher menuLabel: type: string description: Nome do menu do launcher proxyConfigDef: description: Define uma configuração de proxy type: object required: – host – port properties: host: type: string description: Endereço do proxy port: type: integer format: int64 description: Porta do proxy nonProxyHosts: type: string description: Hosts que serão ignorados pelo proxy (separados por vírgula) 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. 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

Este artigo foi útil para você?

 
Leave A Comment
Mais pesquisados:Customização, Tutorial, Documentação