ecossistema

Aplicativo de referência

107 views 22/10/2018 integrador 0

2.0info: 2.0.2 Aplicativo de referência description: Aplicação de referência Senior X Platform x-senior-domain: Ecossistema x-senior-domain-path: ecossistema x-senior-service-path: reference_app contact: name: Senior X Platform url: http://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/ecossistemasecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /reference_app/queries/obterUrlUploadAnexo: post: description: Cria o local para armazenamento e busca URL para upload do anexo ### Resources: – res://senior.com.br/ecossistema/reference_app/entities/tarefa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo properties: nomeAnexo: type: string description: nome do arquivo anexo responses: 200: description: Ok schema: type: object required: – id – url – nome – versao properties: id: type: string description: id unico do arquivo no serviço url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo, informado no input versao: type: string description: versão do arquivo criado default: description: Error response schema: #/definitions/genericError get: description: Cria o local para armazenamento e busca URL para upload do anexo ### Resources: – res://senior.com.br/ecossistema/reference_app/entities/tarefa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nomeAnexo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – id – url – nome – versao properties: id: type: string description: id unico do arquivo no serviço url: type: string description: URL para upload do arquivo nome: type: string description: nome do arquivo, informado no input versao: type: string description: versão do arquivo criado default: description: Error response schema: #/definitions/genericError /reference_app/queries/obterUrlDownloadAnexo: post: description: Obtém a URL para download do anexo ### Resources: – res://senior.com.br/ecossistema/reference_app/entities/tarefa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo properties: nomeAnexo: type: string description: nome do anexo responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download do recuro default: description: Error response schema: #/definitions/genericError get: description: Obtém a URL para download do anexo ### Resources: – res://senior.com.br/ecossistema/reference_app/entities/tarefa tags: – Queries x-senior-visibility: PUBLIC parameters: – name: nomeAnexo in: query required: true type: string responses: 200: description: Ok schema: type: object required: – url properties: url: type: string description: URL para download do recuro default: description: Error response schema: #/definitions/genericError /reference_app/queries/obterTarefa: post: description: Responsável por obter uma determinada tarefa pelo Id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – id properties: id: type: string description: Identificação única da tarefa a ser obtida responses: 200: description: Ok schema: type: object required: – tarefa properties: tarefa: type: object allOf: – #/definitions/tarefa description: Tarefa obtida pelo ID default: description: Error response schema: #/definitions/genericError get: description: Responsável por obter uma determinada tarefa pelo Id tags: – Queries x-senior-visibility: PUBLIC parameters: – name: id in: query required: true type: string responses: 200: description: Ok schema: type: object required: – tarefa properties: tarefa: type: object allOf: – #/definitions/tarefa description: Tarefa obtida pelo ID default: description: Error response schema: #/definitions/genericError /reference_app/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: 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 in: query type: string responses: 200: description: Ok schema: type: object required: – metadata properties: metadata: type: string description: default: description: Error response schema: #/definitions/genericError /reference_app/queries/exportTarefa: post: description: tags: – Queries x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError get: description: tags: – Queries x-senior-visibility: PUBLIC parameters: – name: config in: query required: true type: object allOf: – #/definitions/exportConfig responses: 200: description: Ok schema: type: object required: – exportJobId properties: exportJobId: type: string description: default: description: Error response schema: #/definitions/genericError /reference_app/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies default: description: Error response schema: #/definitions/genericError /reference_app/actions/regra: post: description: Ponto THIS IS AN EXTENSION POINT. EXTENSION POINTS ARE ENDPOINTS MEANT TO BE PROVIDED BY CLIENT SERVICES INSTEAD OF BY THE SERVICE DEFINING THEM. tags: – Actions x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – data properties: data: type: string description: dados responses: 200: description: Ok schema: type: object required: – data properties: data: type: string description: dados default: description: Error response schema: #/definitions/genericError /reference_app/actions/adicionaTarefaRapida: post: description: Adiciona uma tarefa rápida, onde titulo e descrição são o mesmo, com data para o **dia seguinte** ### Resources: – res://senior.com.br/ecossistema/reference_app/actions/adicionaTarefaRapida tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – titulo properties: titulo: type: string description: Titulo e descrição da tarefa responses: 200: description: Ok schema: type: object required: – status properties: status: type: string allOf: – #/definitions/statusCriacaoTarefa description: status de criação da tarefa default: description: Error response schema: #/definitions/genericError /reference_app/actions/salvarAnexo: post: description: Confirma a gravação do arquivo no serviço na versão em que ocorreu o upload ### Resources: – res://senior.com.br/ecossistema/reference_app/entities/tarefa tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo – versao properties: nomeAnexo: type: string description: nome do anexo versao: type: string description: versão do anexo (obtida no retorno da primitiva obterUrlUploadAnexo) responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resultado da operação (OK) default: description: Error response schema: #/definitions/genericError /reference_app/actions/excluirAnexo: post: description: Confirma a gravação do arquivo no serviço na versão em que ocorreu o upload ### Resources: – res://senior.com.br/ecossistema/reference_app/entities/tarefa tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – nomeAnexo properties: nomeAnexo: type: string description: nome do anexo responses: 200: description: Ok schema: type: object required: – result properties: result: type: string description: Resultado da operação (OK) default: description: Error response schema: #/definitions/genericError /reference_app/actions/odata: post: description: tags: – Actions x-senior-visibility: PRIVATE responses: 204: description: No response default: description: Error response schema: #/definitions/genericError /reference_app/actions/importTarefa: post: description: tags: – Actions x-senior-visibility: PUBLIC 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: default: description: Error response schema: #/definitions/genericError /reference_app/entities/tarefa: post: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tarefa responses: 200: description: The created resource schema: #/definitions/tarefa default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: entity in: body required: true schema: type: object allOf: – #/definitions/tarefa responses: 200: description: The created resource schema: #/definitions/tarefa default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: offset in: query type: number – name: size in: query type: number responses: 200: description: Ok schema: type: array items: #/definitions/tarefa default: description: Error response schema: #/definitions/genericError /reference_app/entities/tarefa/{id}: put: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tarefa responses: 200: description: Ok schema: #/definitions/tarefa default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/tarefa responses: 200: description: Ok schema: #/definitions/tarefa default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/tarefa default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – CRUD x-senior-visibility: PRIVATE parameters: – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /reference_app/entities/tarefa/bulk: post: description: This entity is customizable. tags: – Bulk parameters: – name: entities in: body required: true schema: type: array items: – #/definitions/tarefa responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError definitions: statusCriacaoTarefa: description: Define o status de criação de uma tarefa type: string enum: – SUCESSO – ERRO userNotificationKind: description: User notification kind. type: string enum: – Operational – Management – News userNotificationPriority: description: User notification priority. type: string enum: – Error – Alert – None eventEmailFormat: description: Format of the email type: string enum: – HTML – PLAIN_TEXT fieldType: description: type: string enum: – BINARY – BOOLEAN – DATE – DATETIME – DOUBLE – ENUM – INTEGER – MONEY – STRING – TIME fileFormat: description: type: string enum: – CSV – FLAT – JSON – XML hookFunction: description: type: string enum: – BEFORE_PARSE – BEFORE_CONVERSION – ON_ERROR – VALIDATE eventType: description: type: string enum: – CHUNK – DOWNLOAD – ERROR – FINISH – START errorStrategy: description: type: string enum: – CALL_SCRIPT – IGNORE – STOP status: description: type: string enum: – DONE – DONE_WITH_ERRORS – DOWNLOADING – ERROR – NOT_STARTED – RUNNING errorType: description: type: string enum: – CONVERT_ERROR – SERVICE_ERROR tarefa: description: Representa que deve ser feito, ou lembrado type: object required: – titulo – data – description properties: id: type: string format: uuid description: chave primária titulo: type: string description: Título do evento, uma descrição curta data: type: string format: date-time description: A data e hora do evento description: type: string description: Descrição da tarefa notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. importError: description: type: object required: – errorType – lineNumber – bean – message – exceptionClass properties: errorType: type: string allOf: – #/definitions/errorType description: lineNumber: type: integer format: int64 description: bean: type: string description: message: type: string description: exceptionClass: type: string description: fielddto: description: type: object required: – id – name – fieldType properties: id: type: integer format: int64 description: name: type: string description: fieldType: type: string allOf: – #/definitions/fieldType description: start: type: integer format: int64 description: size: type: integer format: int64 description: maskPattern: type: string description: hookdto: description: type: object required: – hookFunction – script properties: hookFunction: type: string allOf: – #/definitions/hookFunction description: script: type: string description: layoutdto: description: type: object required: – id – description – fileFormat – errorStrategy – skipLines – fields properties: id: type: integer format: int64 description: description: type: string description: fileFormat: type: string allOf: – #/definitions/fileFormat description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: delimiter: type: string description: skipLines: type: integer format: int64 description: fields: type: array items: type: object allOf: – #/definitions/fielddto minimum: 1 description: hooks: type: array items: type: object allOf: – #/definitions/hookdto description: importReport: description: type: object required: – id – startTime – endTime – uri – beanClass – serviceClass – layout – sucessCount – errorsCount – filteredCount – skippedCount properties: id: type: string description: startTime: type: string format: date-time description: endTime: type: string format: date-time description: uri: type: string description: beanClass: type: string description: serviceClass: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: sucessCount: type: integer format: int64 description: errorsCount: type: integer format: int64 description: filteredCount: type: integer format: int64 description: skippedCount: type: integer format: int64 description: importErrors: type: array items: type: object allOf: – #/definitions/importError description: exportEventStatus: description: type: object required: – importerId – eventType – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: recordCount: type: integer format: int64 description: importEventStatus: description: type: object required: – importerId – eventType – status – recordCount properties: importerId: type: string description: eventType: type: string allOf: – #/definitions/eventType description: status: type: string allOf: – #/definitions/status description: errorMessage: type: string description: recordCount: type: integer format: int64 description: importReport: type: object allOf: – #/definitions/importReport description: exportConfig: description: type: object required: – uri – layout – async – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: errorStrategy: type: string description: importConfig: description: type: object required: – uri – layout – async – batchSize – errorStrategy properties: uri: type: string description: layout: type: object allOf: – #/definitions/layoutdto description: async: type: boolean description: batchSize: type: integer format: int64 description: errorStrategy: type: string allOf: – #/definitions/errorStrategy description: dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE

Este artigo foi útil para você?

Leave A Comment