2.0info: 6.9.0 service_catalog description: Catalogo de serviços x-senior-domain: platform x-senior-domain-path: platform x-senior-service-path: service_catalog 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/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /service_catalog/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 /service_catalog/queries/checkDependencies: post: description: Verifica o status das dependências dos serviços. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: serviceIds: type: array items: type: object allOf: – #/definitions/serviceUniqueDef description: Serviços (se não for informado irá retornar os metadados de todos os serviços). responses: 200: description: Ok schema: type: object required: – serviceCheckeds properties: serviceCheckeds: type: array items: type: object allOf: – #/definitions/serviceCheckedDef minimum: 1 description: Serviços que foram verificados perante suas dependências. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/listDependencies: post: description: Lista e verifica se as dependências de um ou mais serviços estão adequadas. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: serviceIds: type: array items: type: object allOf: – #/definitions/serviceIdDef description: Serviços (se não for informado irá retornar os metadados de todos os serviços). responses: 200: description: Ok schema: type: object properties: serviceDependencies: type: array items: type: object allOf: – #/definitions/serviceDependenciesDef description: Serviços e suas dependências. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/listDomains: post: description: Lista todos os domínios registrados. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: domainNames: type: array items: type: string description: Domínios registrados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista todos os domínios registrados. tags: – Queries x-senior-visibility: PRIVATE responses: 200: description: Ok schema: type: object properties: domainNames: type: array items: type: string description: Domínios registrados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/retrieveCommandsMetadata: post: description: Obtém os metadados de comandos que respeitarem os filtros informados. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: serviceIds: type: array items: type: object allOf: – #/definitions/serviceUniqueDef description: Serviços (se não for informado irá retornar os metadados de todos os serviços). commandFilter: type: string description: Expressão regular que deve ser utilizada para filtrar os comandos. responses: 200: description: Ok schema: type: object required: – servicesCommandsMetadata properties: servicesCommandsMetadata: type: array items: type: object allOf: – #/definitions/serviceCommandsMetadataDef minimum: 1 description: Metadados dos comandos que respeitam os filtros informados. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/listServices: post: description: Lista os serviços registrados dos domínios informados. Caso não sejam informados domínios, lista todos os serviços. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: O nome do tenant a ser pesquisado domainNames: type: array items: type: string description: Filtra somente os serviços que pertencerem a lista de domínios especificada. Se não definido, será considerado metadataType: type: string description: Filtra somente os serviços que possuírem o arquivo de metadado especificado. Se não definido, será considerado os serviços que possuírem o arquivo sd.json. responses: 200: description: Ok schema: type: object properties: serviceIds: type: array items: type: object allOf: – #/definitions/serviceIdDef description: Serviços. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os serviços registrados dos domínios informados. Caso não sejam informados domínios, lista todos os serviços. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: O nome do tenant a ser pesquisado in: query type: string – name: domainNames description: Filtra somente os serviços que pertencerem a lista de domínios especificada. Se não definido, será considerado in: query type: array items: type: string – name: metadataType description: Filtra somente os serviços que possuírem o arquivo de metadado especificado. Se não definido, será considerado os serviços que possuírem o arquivo sd.json. in: query type: string responses: 200: description: Ok schema: type: object properties: serviceIds: type: array items: type: object allOf: – #/definitions/serviceIdDef description: Serviços. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/listResourceGroups: post: description: Lista agrupadores de recursos, que podem ser serviços e agrupadores de recursos customizados, como relatórios itens de menu, etc. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainNames properties: domainNames: type: array items: type: string minimum: 1 description: Domínios. responses: 200: description: Ok schema: type: object required: – resourceGroups properties: resourceGroups: type: array items: type: object allOf: – #/definitions/resourceGroupDef minimum: 1 description: Grupos de recursos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista agrupadores de recursos, que podem ser serviços e agrupadores de recursos customizados, como relatórios itens de menu, etc. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainNames description: Domínios. in: query required: true type: array items: type: string minimum: 1 responses: 200: description: Ok schema: type: object required: – resourceGroups properties: resourceGroups: type: array items: type: object allOf: – #/definitions/resourceGroupDef minimum: 1 description: Grupos de recursos 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/getOnPremisesServices: post: description: Lista os serviços on premises de um tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – metadataType properties: metadataType: type: string description: Filtra somente os serviços que possuírem o arquivo de metadado especificado tenant: type: string description: O nome do tenant a ser pesquisado. Se não for informado retornará somente os serviços da nuvem. service: type: object allOf: – #/definitions/serviceUniqueDef description: Filtra os serviços que devem ser listados. Se não definido, serão listados todos os serviços responses: 200: description: Ok schema: type: object properties: services: type: array items: type: object allOf: – #/definitions/serviceTenant description: Serviços. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/listOnPremisesDeployedTenants: post: description: Lista os tenants que possuem serviços on premises configurados no ambiente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – metadataType properties: metadataType: type: string description: Filtra somente os serviços que possuírem o arquivo de metadados especificado. responses: 200: description: Ok schema: type: object properties: tenants: type: array items: type: string description: Tenants com serviços on premises. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os tenants que possuem serviços on premises configurados no ambiente tags: – Queries x-senior-visibility: PRIVATE parameters: – name: metadataType description: Filtra somente os serviços que possuírem o arquivo de metadados especificado. in: query required: true type: string responses: 200: description: Ok schema: type: object properties: tenants: type: array items: type: string description: Tenants com serviços on premises. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/listDeployedServices: post: description: Lista os serviços on premises de um tenant tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – metadataType properties: metadataType: type: string description: Filtra somente os serviços que possuírem o arquivo de metadado especificado. tenant: type: string description: O nome do tenant a ser pesquisado. Se não for informado retornará somente os serviços da nuvem. service: type: object allOf: – #/definitions/serviceUniqueDef description: Filtra os serviços que devem ser listados. Se não definido, serão listados todos os serviços. responses: 200: description: Ok schema: type: object properties: cloudServices: type: array items: type: object allOf: – #/definitions/serviceUniqueDef description: Serviços na cloud. onPremisesServices: type: array items: type: object allOf: – #/definitions/serviceUniqueDef description: Serviços on-premises. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/listServicesByInfra: post: description: Lista os serviços registrados dos domínios informados por infra (cloud/on-premises). Caso não sejam informados domínios, lista todos os serviços. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: tenant: type: string description: Tenant. domainNames: type: array items: type: string description: Domínios. reload: type: boolean description: Indica se os metadados devem ser recarregados. responses: 200: description: Ok schema: type: object properties: cloudServiceIds: type: array items: type: object allOf: – #/definitions/fullServiceIdDef description: Serviços na cloud. onPremiseServiceIds: type: array items: type: object allOf: – #/definitions/fullServiceIdDef description: Serviços on-premises. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista os serviços registrados dos domínios informados por infra (cloud/on-premises). Caso não sejam informados domínios, lista todos os serviços. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: tenant description: Tenant. in: query type: string – name: domainNames description: Domínios. in: query type: array items: type: string – name: reload description: Indica se os metadados devem ser recarregados. in: query type: boolean responses: 200: description: Ok schema: type: object properties: cloudServiceIds: type: array items: type: object allOf: – #/definitions/fullServiceIdDef description: Serviços na cloud. onPremiseServiceIds: type: array items: type: object allOf: – #/definitions/fullServiceIdDef description: Serviços on-premises. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/retrieveMetadata: post: description: Lista as primitivas registradas dos serviços informados. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object properties: serviceIds: type: array items: type: object allOf: – #/definitions/serviceIdDef description: Serviços (se não for informado irá retornar os metadados de todos os serviços). responses: 200: description: Ok schema: type: object properties: metadata: type: array items: type: object allOf: – #/definitions/serviceMetadataDef description: Primitivas. versions: type: array items: type: object allOf: – #/definitions/serviceVersionMetadataDef description: Versões das primitivas. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/retrieveMetadatas: post: description: Lista os metadados dos serviços registrados para o tipo informado. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – metaType properties: tenantName: type: string description: Nome do tenant que deve ter os metadados retornados, caso não informado é considerado o tenant do usuário.\n Apenas usuários do tenant master podem consultar metadados de outros tenants. serviceIds: type: array items: type: object allOf: – #/definitions/serviceIdDef description: Serviços (se não for informado irá retornar os metadados de todos os serviços). metaType: type: string description: Tipo do metadado para ser pesquisado cloudOnly: type: boolean description: Retorna apenas os metadados dos serviços que estão disponíveis na nuvem default: false reload: type: boolean description: Indica se os metadados devem ser recarregados. responses: 200: description: Ok schema: type: object properties: metadatas: type: array items: type: object allOf: – #/definitions/typedMetadata description: metadados com metaType 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/retrieveDocumentation: post: description: Retorna a documentação do serviço. tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – documentationFormat properties: tenant: type: string description: Tenant do qual retornar a documentação. domainName: type: string description: Domínio do qual retornar a documentação. serviceName: type: string description: Serviço do qual retornar a documentação. documentationFormat: type: string allOf: – #/definitions/documentationFormat description: Formato da documentação responses: 200: description: Ok schema: type: object required: – documentation properties: documentation: type: string description: Documentação. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/searchCloudMetadata: post: description: Busca pelo termo informado nos metadados dos serviços que estão na nuvem. São buscados apenas os metadados to tipo `SD`, sendo considerado nome do domínio, do serviço e da primitiva, ou uma combinação de ítems seperado por /, como por exemplo platform/user/getUser tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: string description: Termo a ser buscado onlyNotDeprecated: type: boolean description: Apenas os não depreciados default: false offset: type: integer format: int64 description: size: type: integer format: int64 description: types: type: array items: type: string allOf: – #/definitions/elementType description: responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: totalPages: type: integer format: int64 description: contents: type: array items: type: object allOf: – #/definitions/serviceMetadataElement minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/searchOnPremisesMetadata: post: description: Busca pelo termo informado nos metadados dos serviços que estão on-premises. São buscados apenas os metadados to tipo `SD`, sendo considerado nome do domínio, do serviço e da primitiva, ou uma combinação de ítems seperado por /, como por exemplo platform/user/getUser tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – filter properties: filter: type: string description: Termo a ser buscado onlyNotDeprecated: type: boolean description: Apenas os não depreciados default: false offset: type: integer format: int64 description: size: type: integer format: int64 description: types: type: array items: type: string allOf: – #/definitions/elementType description: responses: 200: description: Ok schema: type: object required: – totalElements – totalPages – contents properties: totalElements: type: integer format: int64 description: totalPages: type: integer format: int64 description: contents: type: array items: type: object allOf: – #/definitions/serviceMetadataElement minimum: 1 description: 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/listCommandsByReturnType: post: description: Lista as primitivas que retornam valor de acordo com o filtro permitindo filtrar também por serviços específicos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – outputType properties: domainName: type: string description: Nome do domínio para localizar a primitiva serviceName: type: string description: Nome do serviço para localizar a primitiva outputType: type: string description: Tipo de dados que precisa retornar multivalued: type: boolean description: Tipo do retorno da primitiva se é um valor único ou uma lista de valores default: false responses: 200: description: Ok schema: type: object properties: commandsIdentifier: type: array items: type: object allOf: – #/definitions/commandIdentifier description: Lista o nome das primitivas compatíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Lista as primitivas que retornam valor de acordo com o filtro permitindo filtrar também por serviços específicos tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Nome do domínio para localizar a primitiva in: query type: string – name: serviceName description: Nome do serviço para localizar a primitiva in: query type: string – name: outputType description: Tipo de dados que precisa retornar in: query required: true type: string – name: multivalued description: Tipo do retorno da primitiva se é um valor único ou uma lista de valores in: query type: boolean responses: 200: description: Ok schema: type: object properties: commandsIdentifier: type: array items: type: object allOf: – #/definitions/commandIdentifier description: Lista o nome das primitivas compatíveis 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/getCommandPriority: post: description: Retorna o tipo do comando tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName – primitive properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço primitive: type: string description: Nome da primitiva responses: 200: description: Ok schema: type: object required: – commandPriority properties: commandPriority: type: string description: Prioridade do comando 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna o tipo do comando tags: – Queries x-senior-visibility: PRIVATE parameters: – name: domainName description: Nome do domínio in: query required: true type: string – name: serviceName description: Nome do serviço in: query required: true type: string – name: primitive description: Nome da primitiva in: query required: true type: string responses: 200: description: Ok schema: type: object required: – commandPriority properties: commandPriority: type: string description: Prioridade do comando 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/queries/listServicesInfoAndMetadata: post: description: tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – metaType properties: serviceIds: type: array items: type: object allOf: – #/definitions/serviceUniqueDef description: Serviços (se não for informado irá retornar os metadados de todos os serviços). metaType: type: string description: Tipo do metadado para ser pesquisado responses: 200: description: Ok schema: type: object properties: cloudServiceIds: type: array items: type: object allOf: – #/definitions/fullServiceIdDefMetadata description: Serviços na cloud. 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/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 /service_catalog/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 /service_catalog/actions/syncMetadata: post: description: Atualiza os metadados dos tipos informados na tabela de authorization tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – domainName – serviceName properties: domainName: type: string description: Nome do domínio serviceName: type: string description: Nome do serviço tenantName: type: string description: Nome do tenant que receberá a atualização dos metadados metadataType: type: string description: Tipo do metadado a ser atualizado responses: 200: description: Ok schema: type: object 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /service_catalog/events/serviceMetadataChanged: post: description: Service metadata changed. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – serviceId properties: serviceId: type: object allOf: – #/definitions/serviceIdDef description: Changed service id. responses: 200: description: OK default: description: Error response schema: #/definitions/genericError /service_catalog/events/serviceTypedMetadataChanged: post: description: Service typed metadata changed. x-senior-event: true tags: – Events parameters: – name: input in: body required: true schema: type: object required: – serviceId properties: serviceId: type: object allOf: – #/definitions/typedServiceIdDef description: Changed typed service id. actionPerformed: type: string allOf: – #/definitions/actionPerformed description: Action performed. responses: 200: description: OK default: description: Error response schema: #/definitions/genericErrordefinitions: healthCheckStatus: description: Status do Healthcheck type: string enum: – UP – DOWN documentationFormat: description: Documentation format type: string enum: – PUBLIC_SWAGGER – OPENAPI – SWAGGER – WSDL – SD elementType: description: type: string enum: – COMMAND – SIGNAL – RECORD – ENUM – ENTITY – EVENT – APIS – OPEN_API actionPerformed: description: type: string enum: – DELETED – UPDATED 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 serviceTenant: description: type: object required: – service – tenant properties: service: type: object allOf: – #/definitions/serviceUniqueDef description: tenant: type: string description: serviceUniqueDef: description: Service unique. discriminator: _discriminator type: object required: – domainName – serviceName – _discriminator properties: domainName: type: string description: Domain name. domainLabel: type: string description: Domain label domainDescription: type: string description: Domain description serviceName: type: string description: Service name. serviceLabel: type: string description: Service label serviceDescription: type: string description: Service description _discriminator: type: string description: serviceCheckedDef: description: Represents the status of each service with its dependencies. allOf: – #/definitions/serviceUniqueDef – type: object required: – ok properties: ok: type: boolean description: If the dependencies meets the requirements the value is true. reasons: type: array items: type: object allOf: – #/definitions/dependencyReasonDef description: List of reasons (if the result of ok is false) serviceIdDef: description: Service id. This record has the same fields as fullServiceIdDef to keep backwards compatibility allOf: – #/definitions/serviceUniqueDef – type: object properties: type: string description: Service version typedServiceIdDef: description: typed service id. allOf: – #/definitions/serviceUniqueDef – type: object required: – metaType properties: metaType: type: string description: metaType name fullServiceIdDef: description: Service id with more information. allOf: – #/definitions/serviceUniqueDef – type: object properties: type: string description: Service version fullServiceIdDefMetadata: description: Service id with more information. allOf: – #/definitions/fullServiceIdDef – type: object required: – metadata – metaType properties: metadata: type: string description: Metadata value from service metaType: type: string description: Metadata type from service serviceCommandsMetadataDef: description: Metadados dos comandos de um serviço. allOf: – #/definitions/fullServiceIdDef – type: object required: – commandsMetadata properties: commandsMetadata: type: array items: type: object allOf: – #/definitions/serviceComponentMetadataDef minimum: 1 description: Service commands. serviceMetadataDef: description: Service metadata. allOf: – #/definitions/serviceCommandsMetadataDef – type: object required: – signalsMetadata – recordsMetadata – enumerarionsMetadata – entitiesMetadata – eventsMetadata properties: signalsMetadata: type: array items: type: object allOf: – #/definitions/serviceComponentMetadataDef minimum: 1 description: Service signals. recordsMetadata: type: array items: type: object allOf: – #/definitions/serviceComponentMetadataDef minimum: 1 description: Service record. enumerarionsMetadata: type: array items: type: object allOf: – #/definitions/serviceComponentMetadataDef minimum: 1 description: Service enumerations. entitiesMetadata: type: array items: type: object allOf: – #/definitions/serviceComponentMetadataDef minimum: 1 description: Service entities. eventsMetadata: type: array items: type: object allOf: – #/definitions/serviceComponentMetadataDef minimum: 1 description: Service events serviceVersionMetadataDef: description: Service version metadata. type: object required: – metadata properties: type: integer format: int64 description: Service version. metadata: type: object allOf: – #/definitions/serviceMetadataDef description: Service version metadata. serviceMetadataElement: description: allOf: – #/definitions/serviceUniqueDef – type: object required: – type – element properties: type: type: string allOf: – #/definitions/elementType description: element: type: object allOf: – #/definitions/serviceComponentMetadataDef description: typedMetadata: description: Typed service metadata . allOf: – #/definitions/typedServiceIdDef – type: object required: – metadata – shared properties: metadata: type: string description: Service commands. shared: type: boolean description: Informa se os metadados são do tenant ou compartilhados. serviceComponentMetadataDef: description: Service component metadata. type: object required: – name – metadata properties: name: type: string description: Service component name. type: integer format: int64 description: Service component version. metadata: type: string description: Service component metadata. resourceGroupDef: description: A group or resources allOf: – #/definitions/serviceUniqueDef – type: object required: – type properties: type: type: string description: Type of grouper, can be SERVICE, CUSTOM_GROUP serviceDependenciesDef: description: Service dependency status allOf: – #/definitions/serviceUniqueDef – type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependencyDef minimum: 1 description: List of dependencies dependencyDef: description: Dependency of the service allOf: – #/definitions/fullServiceIdDef – type: object dependencyReasonDef: description: Fail dependency reason allOf: – #/definitions/serviceUniqueDef – type: object required: – expectedVersion – currentVersion properties: expectedVersion: type: string description: Expected version dependency by the service currentVersion: type: string description: Current version dependency by the service commandIdentifier: description: Retorna as primitivas com domínio e serviço compatíveis com a busca type: object required: – domainName – serviceName – commandName properties: domainName: type: string description: Domain name. serviceName: type: string description: Service name. commandName: type: string description: Nome da primitiva 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