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

royalties_hub

13 views 0 02/07/2024 Atualizado em 09/10/2024 integrador

2.0info: 1.3.0 royalties_hub description: Hub de Integrações Royalties x-senior-domain: Agro x-senior-domain-path: agro x-senior-service-path: royalties_hub 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/agrosecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /royalties_hub/queries/listCompanies: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: valor a ser filtrado searchId: type: string description: id a ser filtrado searchName: type: string description: nome a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 orderBy: type: string description: ordenação default: desc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchTerm description: valor a ser filtrado in: query type: string – name: searchId description: id a ser filtrado in: query type: string – name: searchName description: nome a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 – name: orderBy description: ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/queries/listBranches: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: valor a ser filtrado searchId: type: string description: id a ser filtrado companyId: type: string description: id da empresa searchName: type: string description: nome a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 orderBy: type: string description: ordenação default: desc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchTerm description: valor a ser filtrado in: query type: string – name: searchId description: id a ser filtrado in: query type: string – name: companyId description: id da empresa in: query type: string – name: searchName description: nome a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 – name: orderBy description: ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/queries/listProducers: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: valor a ser filtrado searchId: type: string description: id a ser filtrado companyId: type: string description: id da empresa searchName: type: string description: nome a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 orderBy: type: string description: ordenação default: desc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchTerm description: valor a ser filtrado in: query type: string – name: searchId description: id a ser filtrado in: query type: string – name: companyId description: id da empresa in: query type: string – name: searchName description: nome a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 – name: orderBy description: ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/queries/listProducts: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: valor a ser filtrado searchId: type: string description: id a ser filtrado companyId: type: string description: id da empresa searchName: type: string description: nome a ser filtrado page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 orderBy: type: string description: ordenação default: desc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchTerm description: valor a ser filtrado in: query type: string – name: searchId description: id a ser filtrado in: query type: string – name: companyId description: id da empresa in: query type: string – name: searchName description: nome a ser filtrado in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 – name: orderBy description: ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/queries/listPackingList: post: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: searchTerm: type: string description: valor a ser filtrado searchId: type: string description: id a ser filtrado companyId: type: string description: id da empresa page: type: integer format: int64 description: paginação default: 0 rows: type: integer format: int64 description: quantidade por página default: 10 orderBy: type: string description: ordenação default: desc responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: searchTerm description: valor a ser filtrado in: query type: string – name: searchId description: id a ser filtrado in: query type: string – name: companyId description: id da empresa in: query type: string – name: page description: paginação in: query type: integer format: int64 – name: rows description: quantidade por página in: query type: integer format: int64 – name: orderBy description: ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalElements properties: data: type: array items: type: object allOf: – #/definitions/defaultDataLookup description: Lista dos estados disponíveis totalElements: type: integer format: int64 description: Quantidade de registros retornados 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/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 /royalties_hub/queries/exportSettings: 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 /royalties_hub/queries/exportDelivery: 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 /royalties_hub/queries/exportMonitor: 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 /royalties_hub/queries/exportMonitorFailure: 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 /royalties_hub/queries/exportFixation: 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 /royalties_hub/queries/exportUrl: 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 /royalties_hub/queries/exportFailure: 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 /royalties_hub/queries/exportPendingList: 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 /royalties_hub/queries/exportLogIntegration: 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 /royalties_hub/queries/exportLogIntegrationErrors: 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 /royalties_hub/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 /royalties_hub/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 /royalties_hub/actions/testConnection: post: description: Testa a conexão com o provedor de royalties tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – clientId – clientSecret properties: clientId: type: string description: Client Id clientSecret: type: string description: Client Secret responses: 200: description: Ok schema: type: object required: – token properties: token: type: string description: Token 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/actions/deliveryRegister: post: description: Primitiva para receber as informações de entrega (processamento em lote) tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – deliveryReceivedList properties: deliveryReceivedList: type: array items: type: object allOf: – #/definitions/deliveryReceived minimum: 1 description: Lista de Delivery que será processada pela rotina responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/deliveryActionResponse minimum: 1 description: Lista de resultado do processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/actions/fixationRegister: post: description: Primitiva para fixação de royalties tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – fixationRegisterList properties: fixationRegisterList: type: array items: type: object allOf: – #/definitions/fixationReceivedPayload minimum: 1 description: Lista de Fixation que será processada pela rotina responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/fixationRegisterResponse minimum: 1 description: Lista de resultado do processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/actions/deliveryCancel: post: description: Primitiva para cancelar a entrega (processamento em lote) tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – deliveryCancelList properties: deliveryCancelList: type: array items: type: object allOf: – #/definitions/deliveryCancelPayload minimum: 1 description: Lista de Delivery que será processada pela rotina responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/deliveryActionResponse minimum: 1 description: Lista de resultado do processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/actions/checkStatus: post: description: Primitiva para consultar o status da entrega tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – checkStatusList properties: checkStatusList: type: array items: type: object allOf: – #/definitions/payloadCheckStatus minimum: 1 description: Lista de checkStatus que será processada pela rotina responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/checkStatusResponse minimum: 1 description: Lista de resultado do processamento 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/actions/checkStatusFixRoyalties: post: description: Primitiva para consultar o status da fixação de royalties tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – checkStatusList properties: checkStatusList: type: array items: type: object allOf: – #/definitions/payloadCheckStatusFixRoyalties minimum: 1 description: Lista de checkStatusFixRoyalties que será processada pela rotina responses: 200: description: Ok schema: type: object required: – data properties: data: type: array items: type: object allOf: – #/definitions/checkStatusFixRoyaltiesResponse minimum: 1 description: Lista de resultado do Check Status Fixação de Royalties 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/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 /royalties_hub/actions/importSettings: 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 /royalties_hub/actions/importDelivery: 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 /royalties_hub/actions/importMonitor: 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 /royalties_hub/actions/importMonitorFailure: 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 /royalties_hub/actions/importFixation: 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 /royalties_hub/actions/importUrl: 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 /royalties_hub/actions/importFailure: 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 /royalties_hub/actions/importPendingList: 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 /royalties_hub/actions/importLogIntegration: 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 /royalties_hub/actions/importLogIntegrationErrors: 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 /royalties_hub/signals/updateStatus: post: description: Primitiva para atualizar os status de processamento tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /royalties_hub/signals/checkPendingList: post: description: Primitiva para consultar a lista de pendências tags: – Signals parameters: – name: input in: body required: true schema: type: object responses: 202: description: Accepted default: description: Error response schema: #/definitions/genericError /royalties_hub/events/importSettingsEvent: 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 /royalties_hub/events/exportSettingsEvent: 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 /royalties_hub/events/importDeliveryEvent: 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 /royalties_hub/events/exportDeliveryEvent: 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 /royalties_hub/events/importMonitorEvent: 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 /royalties_hub/events/exportMonitorEvent: 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 /royalties_hub/events/importMonitorFailureEvent: 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 /royalties_hub/events/exportMonitorFailureEvent: 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 /royalties_hub/events/importFixationEvent: 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 /royalties_hub/events/exportFixationEvent: 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 /royalties_hub/events/importUrlEvent: 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 /royalties_hub/events/exportUrlEvent: 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 /royalties_hub/events/importFailureEvent: 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 /royalties_hub/events/exportFailureEvent: 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 /royalties_hub/events/importPendingListEvent: 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 /royalties_hub/events/exportPendingListEvent: 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 /royalties_hub/events/importLogIntegrationEvent: 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 /royalties_hub/events/exportLogIntegrationEvent: 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 /royalties_hub/events/importLogIntegrationErrorsEvent: 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 /royalties_hub/events/exportLogIntegrationErrorsEvent: 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 /royalties_hub/entities/settings: 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/settings responses: 200: description: The created resource schema: #/definitions/settings 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/settings responses: 200: description: The created resource schema: #/definitions/settings 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/settings 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/settings/{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/settings responses: 200: description: Ok schema: #/definitions/settings 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/settings responses: 200: description: Ok schema: #/definitions/settings 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/settings 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 /royalties_hub/entities/settings/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/settings responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/delivery: 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/delivery responses: 200: description: The created resource schema: #/definitions/delivery 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/delivery responses: 200: description: The created resource schema: #/definitions/delivery 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/delivery 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/delivery/{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/delivery responses: 200: description: Ok schema: #/definitions/delivery 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/delivery responses: 200: description: Ok schema: #/definitions/delivery 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/delivery 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 /royalties_hub/entities/delivery/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/delivery responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/monitor: 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/monitor responses: 200: description: The created resource schema: #/definitions/monitor 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/monitor responses: 200: description: The created resource schema: #/definitions/monitor 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/monitor 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/monitor/{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/monitor responses: 200: description: Ok schema: #/definitions/monitor 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/monitor responses: 200: description: Ok schema: #/definitions/monitor 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/monitor 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 /royalties_hub/entities/monitor/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/monitor responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/monitorFailure: 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/monitorFailure responses: 200: description: The created resource schema: #/definitions/monitorFailure 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/monitorFailure responses: 200: description: The created resource schema: #/definitions/monitorFailure 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/monitorFailure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/monitorFailure/{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/monitorFailure responses: 200: description: Ok schema: #/definitions/monitorFailure 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/monitorFailure responses: 200: description: Ok schema: #/definitions/monitorFailure 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/monitorFailure 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 /royalties_hub/entities/monitorFailure/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/monitorFailure responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/fixation: 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/fixation responses: 200: description: The created resource schema: #/definitions/fixation 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/fixation responses: 200: description: The created resource schema: #/definitions/fixation 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/fixation 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/fixation/{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/fixation responses: 200: description: Ok schema: #/definitions/fixation 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/fixation responses: 200: description: Ok schema: #/definitions/fixation 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/fixation 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 /royalties_hub/entities/fixation/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/fixation responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/url: 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/url responses: 200: description: The created resource schema: #/definitions/url 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/url responses: 200: description: The created resource schema: #/definitions/url 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/url 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/url/{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/url responses: 200: description: Ok schema: #/definitions/url 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/url responses: 200: description: Ok schema: #/definitions/url 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/url 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 /royalties_hub/entities/url/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/url responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/failure: 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/failure responses: 200: description: The created resource schema: #/definitions/failure 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/failure responses: 200: description: The created resource schema: #/definitions/failure 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/failure 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/failure/{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/failure responses: 200: description: Ok schema: #/definitions/failure 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/failure responses: 200: description: Ok schema: #/definitions/failure 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/failure 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 /royalties_hub/entities/failure/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/failure responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/pendingList: 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/pendingList responses: 200: description: The created resource schema: #/definitions/pendingList 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/pendingList responses: 200: description: The created resource schema: #/definitions/pendingList 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/pendingList 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/pendingList/{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/pendingList responses: 200: description: Ok schema: #/definitions/pendingList 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/pendingList responses: 200: description: Ok schema: #/definitions/pendingList 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/pendingList 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 /royalties_hub/entities/pendingList/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/pendingList responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/logIntegration: 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/logIntegration responses: 200: description: The created resource schema: #/definitions/logIntegration 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/logIntegration responses: 200: description: The created resource schema: #/definitions/logIntegration 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/logIntegration 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/logIntegration/{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/logIntegration responses: 200: description: Ok schema: #/definitions/logIntegration 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/logIntegration responses: 200: description: Ok schema: #/definitions/logIntegration 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/logIntegration 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 /royalties_hub/entities/logIntegration/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/logIntegration responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/logIntegrationErrors: 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/logIntegrationErrors responses: 200: description: The created resource schema: #/definitions/logIntegrationErrors 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/logIntegrationErrors responses: 200: description: The created resource schema: #/definitions/logIntegrationErrors 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/logIntegrationErrors 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /royalties_hub/entities/logIntegrationErrors/{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/logIntegrationErrors responses: 200: description: Ok schema: #/definitions/logIntegrationErrors 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/logIntegrationErrors responses: 200: description: Ok schema: #/definitions/logIntegrationErrors 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/logIntegrationErrors 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 /royalties_hub/entities/logIntegrationErrors/bulk: post: description: Esta entidade pode ser customizada. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: #/definitions/logIntegrationErrors responses: 200: description: The bulk creation has created resources 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericErrordefinitions: chargeResult: description: type: string enum: – POSITIVE – NEGATIVE – DECLARED typeDocument: description: type: string enum: – CPF – CNPJ typeCharge: description: type: string enum: – PLATE – DOCUMENT – OTHER typeOperation: description: type: string enum: – AUTHENTICATION – DELIVERY_REGISTER – FIXATION_REGISTER – DELIVERY_CANCEL – CHECK_STATUS – CHECK_STATUS_FIXATION – CHECK_PENDING typeStatus: description: type: string enum: – REGISTERED – REJECTED – VALIDATION_ERROR – CANCELLED – PROCESSING_ROL – PROCESSING_CANCEL – APPROVED – PROCESSING – SUCCESS – ERROR typeStatusCredit: description: type: string enum: – TOTAL – PARTIAL – NO_CONSUMPTION typeUrl: description: type: string enum: – AUTHENTICATION – DELIVERY – CHECK_STATUS – CANCEL – FIXATION – CHECK_STATUS_FIX – CHECK_PENDING – CONSUME_PENDING – CHECK_CONSUME_PENDING typeEnvironment: description: type: string enum: – PRODUCTION – HOMOLOGATION typeStatusLog: description: type: string enum: – SUCCESS – ERROR 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 deliveryReceived: description: DTO de entrega type: object required: – headOfficeDocNumber – headOfficeName – affiliateDocNumber – affiliateName – growerDocNumber – growerName – qtdDelivery – deliveryDate – chargeResult – technology – chargeType – chargeId – integrationId properties: headOfficeDocNumber: type: string description: Documento da Empresa headOfficeName: type: string description: Nome da Empresa affiliateDocNumber: type: string description: Documento da Filial affiliateName: type: string description: Nome da Filial growerDocNumber: type: string description: Documento do Produtor growerName: type: string description: Nome do Produtor productCode: type: string description: Código do Produto productName: type: string description: Nome do Produto qtdDelivery: type: number format: double description: Quantidade Entregue deliveryDate: type: string format: date description: Data de Entrega chargeResult: type: string allOf: – #/definitions/chargeResult description: Resultado da Carga technology: type: string description: Tecnologia chargeType: type: string allOf: – #/definitions/typeCharge description: Tipo de Carga chargeId: type: string description: Id da Carga truckType: type: string description: Tipo de Caminhão truckId: type: string description: Id do Caminhão integrationId: type: string maxLength: 255 description: ID da integração deliveryCancelPayload: description: type: object required: – deliveryId – deliveryDate – integrationId properties: deliveryId: type: string description: Id da Entrega deliveryDate: type: string format: date description: Data do Envio da Entrega integrationId: type: string maxLength: 255 description: ID da integração fixationReceivedPayload: description: DTO da fixação de royalties type: object required: – matrixDocNumber – matrixOfficeName – affiliateDocNumber – affiliateName – growerDocNumber – growerName – fixNumber – quantity – integrationId properties: matrixDocNumber: type: string description: Documento da Empresa matrixOfficeName: type: string description: Nome da Empresa affiliateDocNumber: type: string description: Documento da Filial affiliateName: type: string description: Nome da Filial growerDocNumber: type: string description: Documento do Produtor growerName: type: string description: Nome do Produtor fixNumber: type: string description: Número da Fixação quantity: type: number format: double description: Quantidade a Fixar integrationId: type: string maxLength: 255 description: ID da integração payloadResponseDelivery: description: DTO de responsa da entrega, cancelamento e status da entrega type: object required: – status properties: status: type: string description: Status results: type: array items: type: object allOf: – #/definitions/deliveryResult description: Resultado message: type: string description: Mensagem payloadResponseFixation: description: DTO de responsa da fixação de royalties type: object required: – code – status properties: code: type: integer format: int64 description: Código de retorno status: type: string description: Status da fixação message: type: string description: Mensagem de retorno body: type: object allOf: – #/definitions/responseFix description: responseFix: description: DTO de corpo da resposta da fixação de royalties type: object required: – id properties: id: type: string description: Id da fixação de royalties deliveryResult: description: DTO de resultado da entrega type: object required: – deliveryId – creationDate – status – quantity properties: deliveryId: type: string description: Delivery Id bid: type: string description: Identificador Sistema Externo creationDate: type: string description: Data da Criação do Registro status: type: string description: Status do Registro quantity: type: string description: Quantidade Consumida/Cancelada errors: type: array items: type: object allOf: – #/definitions/deliveryError description: Erros deliveryError: description: DTO de erro da entrega type: object required: – type – message properties: type: type: string description: Tipo do Erro message: type: string description: Mensagem do Erro payloadAuthentication: description: DTO do payload de autenticação type: object required: – client_id – client_secret – grant_type properties: client_id: type: string description: Client Id client_secret: type: string description: Client Secret grant_type: type: string description: Tipo de Permissão payloadResponseAuthentication: description: DTO do payload de resposta de autenticação type: object required: – access_token – expiration_date – token_type properties: access_token: type: string description: Token expiration_date: type: integer format: int64 description: Tempo de Expiração do Token token_type: type: string description: Tipo do Token payloadSendDelivery: description: DTO do payload de envio type: object required: – headOfficeDocNumber – affiliateDocNumber – growerDocNumber – volume – deliveryDate – status – technology – cargoType – cargoId – truckType – truckId properties: headOfficeDocNumber: type: string description: Documento da Empresa affiliateDocNumber: type: string description: Documento da Filial growerDocNumber: type: string description: Documento do Produtor volume: type: string description: Volume Entregue deliveryDate: type: string description: Data da Entrega status: type: string description: Status da Entrega technology: type: string description: Tecnologia cargoType: type: string description: Tipo da Carga cargoId: type: string description: Identificação da Carga truckType: type: string description: Tipo do Caminhão truckId: type: string description: Identificação do Caminhão payloadSendFixation: description: DTO do payload de envio de fixação type: object required: – matrixDocNumber – affiliateDocNumber – growerDocNumber – fixedprice properties: matrixDocNumber: type: string description: Documento da Empresa affiliateDocNumber: type: string description: Documento da Filial growerDocNumber: type: string description: Documento do Produtor fixedprice: type: number format: double description: Quantidade a Fixar payloadSendCancel: description: DTO do payload de envio de cancelamento type: object required: – deliveryId – creation_date properties: deliveryId: type: string description: Id da Entrega creation_date: type: string description: Data do Cancelamento payloadResponsePending: description: DTO do payload de retorno da consulta de pendência type: object properties: totalRows: type: string description: Total de registros totalPages: type: integer format: int64 description: Total de páginas data: type: array items: type: object allOf: – #/definitions/dataPendinglist description: Informações da lista de pedências dataPendinglist: description: DTO com as informações da lista de pedências type: object required: – affiliateDocNumber – matrixDocNumber – growerDocNumber – qty_pending – qty_avialable properties: affiliateDocNumber: type: string description: Documento da Filial matrixDocNumber: type: string description: Documento da Empresa growerDocNumber: type: string description: Documento do Produtor qty_pending: type: string description: Quantidade Pendente qty_avialable: type: string description: Quantidade Disponível resultCheckStatus: description: DTO de resultado do check status type: object required: – status – quantityRegistered – quantityConsumed – quantityCancelled – quantityPending – bid – integrationId properties: status: type: string allOf: – #/definitions/typeStatus description: Status quantityRegistered: type: number format: double description: Quantidade Registrada quantityConsumed: type: number format: double description: Quantidade Consumida quantityCancelled: type: number format: double description: Quantidade Cancelada quantityPending: type: number format: double description: Quantidade Pendente bid: type: string maxLength: 255 description: Código Interno de Consumo (Protocolo) – Bayer integrationId: type: string maxLength: 255 description: ID da integração messages: type: array items: type: string description: resultCheckStatusFix: description: DTO de resultado do check status da fixação de royalties type: object required: – status – integrationId properties: status: type: string allOf: – #/definitions/typeStatus description: Status quantityFixed: type: number format: double description: Quantidade Fixada integrationId: type: string maxLength: 255 description: ID da integração defaultDataLookup: description: Retorno padrão para lookup de dados type: object required: – id – description properties: id: type: string description: Id description: type: string description: Descrição recLogIntegration: description: DTO de Log de Integração type: object properties: settings: type: object allOf: – #/definitions/settings description: Empresa affiliateDocNumber: type: string description: Filial operation: type: string allOf: – #/definitions/typeOperation description: Endpoint status: type: string allOf: – #/definitions/typeStatusLog description: Status payloadSend: type: string description: Payload de Entrada payloadReturn: type: string description: Payload de Saída recErrorLogIntegration: description: Dto de Retorno de Erro de Integração type: object properties: message: type: string description: Log de Integração deliveryActionResponse: description: Retorno padrão para primitivas de actions com Delivery Entity type: object required: – statusCode – message – deliveryId – integrationId properties: statusCode: type: integer format: int64 description: StatusCode da requisição message: type: string description: Campo para mensagem em caso de falhas deliveryId: type: string description: Delivery Id integrationId: type: string maxLength: 255 description: ID da integração fixationRegisterResponse: description: Response do cadastro de fixation type: object required: – statusCode – message – id – integrationId properties: statusCode: type: integer format: int64 description: StatusCode da requisição message: type: string description: Campo para mensagem em caso de falhas id: type: string description: Id da fixação de royalties integrationId: type: string maxLength: 255 description: ID da integração checkStatusResponse: description: Response da rotina de checkStatus (delivery) type: object required: – statusCode – message – deliveryId – integrationId – result properties: statusCode: type: integer format: int64 description: StatusCode da requisição message: type: string description: Campo para mensagem em caso de falhas deliveryId: type: string description: Delivery Id integrationId: type: string maxLength: 255 description: ID da integração result: type: object allOf: – #/definitions/resultCheckStatus description: Resultado do check status payloadCheckStatus: description: Payload para a rotina de checkStatus (delivery) type: object required: – deliveryId – integrationId properties: deliveryId: type: string description: Id da Entrega integrationId: type: string maxLength: 255 description: ID da integração payloadCheckStatusFixRoyalties: description: Payload para a rotina de checkStatusFixation type: object required: – id – integrationId properties: id: type: string description: Id da Fixação de Royalties integrationId: type: string maxLength: 255 description: ID da integração checkStatusFixRoyaltiesResponse: description: Response da rotina de checkStatusFixRoyalties (Fixation) type: object required: – statusCode – message – id – integrationId – result properties: statusCode: type: integer format: int64 description: StatusCode da requisição message: type: string description: Campo para mensagem em caso de falhas id: type: string description: Id da fixação de royalties integrationId: type: string maxLength: 255 description: ID da integração result: type: object allOf: – #/definitions/resultCheckStatusFix description: Resultado do check status settings: description: Parâmetros de Configuração type: object required: – document – name – clientId – clientSecret – environment properties: id: type: string format: uuid description: Id document: type: string description: CNPJ da empresa name: type: string description: Nome da empresa clientId: type: string description: Client Id do provedor clientSecret: type: string description: Client Secret do provedor environment: type: string allOf: – #/definitions/typeEnvironment description: Tipo do Ambiente createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: delivery: description: Entrega type: object required: – headOfficeDocNumber – headOfficeName – affiliateDocNumber – affiliateName – growerDocNumber – growerName – qtdDelivery – deliveryDate – chargeResult – technology – chargeType – chargeId properties: id: type: string format: uuid description: Id headOfficeDocNumber: type: string description: Documento da Empresa headOfficeName: type: string description: Nome da Empresa affiliateDocNumber: type: string description: Documento da Filial affiliateName: type: string description: Nome da Filial growerDocNumber: type: string description: Documento do Produtor growerName: type: string description: Nome do Produtor productCode: type: string description: Código do Produto productName: type: string description: Nome do Produto qtdDelivery: type: number format: double description: Quantidade Entregue qtdConsumed: type: number format: double description: Quantidade Consumida qtdPending: type: number format: double description: Quantidade Pendente qtdCancelled: type: number format: double description: Quantidade Cancelada deliveryDate: type: string format: date description: Data de Entrega chargeResult: type: string allOf: – #/definitions/chargeResult description: Resultado da Carga technology: type: string description: Tecnologia chargeType: type: string description: Tipo de Carga chargeId: type: string description: Id da Carga truckType: type: string description: Tipo de Caminhão truckId: type: string description: Id do Caminhão deliveryId: type: string description: Delivery Id status: type: string allOf: – #/definitions/typeStatus description: Status creditStatus: type: string allOf: – #/definitions/typeStatusCredit description: Status de Crédito bid: type: string maxLength: 255 description: Código Interno de Consumo (Protocolo) – Bayer createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: monitor: description: Monitor type: object required: – dateRegister – operation – status properties: id: type: string format: uuid description: Id delivery: type: object allOf: – #/definitions/delivery description: Delivery fixation: type: object allOf: – #/definitions/fixation description: Fixation dateRegister: type: string format: date-time description: Data/Hora Registro operation: type: string allOf: – #/definitions/typeOperation description: Operação message: type: string description: Mensagem status: type: string allOf: – #/definitions/typeStatus description: Status payloadSend: type: string description: Payload de Envio payloadReturn: type: string description: Payload de Retorno createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: monitorFailure: description: type: object required: – monitor – failure properties: id: type: string format: uuid description: Id monitor: type: object allOf: – #/definitions/monitor description: Monitor failure: type: object allOf: – #/definitions/failure description: Falha createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: fixation: description: Fixação de Royalties type: object required: – matrixDocNumber – matrixOfficeName – affiliateDocNumber – affiliateName – growerDocNumber – growerName – fixNumber – quantity properties: id: type: string format: uuid description: Id matrixDocNumber: type: string description: Documento da Empresa matrixOfficeName: type: string description: Nome da Empresa affiliateDocNumber: type: string description: Documento da Filial affiliateName: type: string description: Nome da Filial growerDocNumber: type: string description: Documento do Produtor growerName: type: string description: Nome do Produtor fixNumber: type: string description: Número da Fixação deliveryId: type: string description: Identificação de Entrega quantity: type: number format: double description: Quantidade a Fixar quantityFixed: type: number format: double description: Quantidade Fixada status: type: string allOf: – #/definitions/typeStatus description: Status createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: url: description: type: object required: – type – environment – url properties: id: type: string format: uuid description: Id type: type: string allOf: – #/definitions/typeUrl description: Tipo da URL environment: type: string allOf: – #/definitions/typeEnvironment description: Tipo do Ambiente url: type: string description: URL createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: failure: description: type: object required: – type – message properties: id: type: string format: uuid description: Id type: type: string description: Tipo do Erro message: type: string description: Mensagem do Erro createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: pendingList: description: type: object required: – settings – affiliateDocNumber – growerDocNumber – quantityPending – quantityAvailable properties: id: type: string format: uuid description: Id settings: type: object allOf: – #/definitions/settings description: Configurações da Empresa affiliateDocNumber: type: string description: Documento da Filial growerDocNumber: type: string description: Documento do Produtor quantityPending: type: number format: double description: Quantidade Pendente quantityAvailable: type: number format: double description: Quantidade Disponível createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: logIntegration: description: type: object required: – dateRegister – operation – status properties: id: type: string format: uuid description: Id dateRegister: type: string format: date-time description: Data/Hora Registro settings: type: object allOf: – #/definitions/settings description: Empresa affiliateDocNumber: type: string description: Filial operation: type: string allOf: – #/definitions/typeOperation description: Operação status: type: string allOf: – #/definitions/typeStatusLog description: Status payloadSend: type: string description: Payload de Envio payloadReturn: type: string description: Payload de Retorno createdBy: type: string description: createdDate: type: string format: date-time description: lastModifiedBy: type: string description: lastModifiedDate: type: string format: date-time description: logIntegrationErrors: description: type: object required: – logIntegration – message properties: id: type: string format: uuid description: Id logIntegration: type: object allOf: – #/definitions/logIntegration description: Log de Integração message: type: string description: Erro 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 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

Este artigo foi útil para você?

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