2.0info: 2.8.1 Entity Manager description: Serviço para Gerenciamento de Entidades dinâmicas na Plataforma Senior X x-senior-domain: Plataforma x-senior-domain-path: platform x-senior-service-path: entity_manager contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: platform.senior.com.br /t/senior.com.br/bridge/1.0/rest/platformsecurityDefinitions: APIKeyHeader: type: apiKey in: header name: Authorizationsecurity: – APIKeyHeader: [] – application/json – application/jsonpaths: /entity_manager/queries/healthcheck: post: description: Query for health check – SRE tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Query for health check – SRE tags: – Queries x-senior-visibility: PUBLIC parameters: responses: 200: description: Ok schema: type: object required: – status – checks properties: status: type: string allOf: – #/definitions/upDown description: Status checks: type: array items: type: object allOf: – #/definitions/checkData minimum: 1 description: Verify 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entity_manager/queries/listEntityNames: post: description: Retorna o nome de todas as Entidades existentes na base da empresa\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – View tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default responses: 200: description: Ok schema: type: object required: – entityNames properties: entityNames: type: array items: type: string minimum: 1 description: Lista com nome das Entidades 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError get: description: Retorna o nome de todas as Entidades existentes na base da empresa\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – View tags: – Queries x-senior-visibility: PUBLIC parameters: – name: namespace description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). in: query type: string maxLength: 100 responses: 200: description: Ok schema: type: object required: – entityNames properties: entityNames: type: array items: type: string minimum: 1 description: Lista com nome das Entidades 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /entity_manager/queries/getEntity: post: description: Retorna Entidade de acordo com nome informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – View\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – View tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da entidade responses: 200: description: Ok schema: type: object allOf: – #/definitions/entityResponse 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError get: description: Retorna Entidade de acordo com nome informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – View\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – View tags: – Queries x-senior-visibility: PUBLIC parameters: – name: namespace description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). in: query type: string maxLength: 100 – name: entityName description: Nome da entidade in: query required: true type: string maxLength: 100 responses: 200: description: Ok schema: type: object allOf: – #/definitions/entityResponse 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /entity_manager/queries/getFormData: post: description: Retorna informações do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: input in: body required: true schema: type: object required: – entityName – recordId properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string description: Nome da entidade recordId: type: integer format: int64 description: Id responses: 200: description: Ok schema: type: object required: – content properties: content: type: string format: byte description: Retorna informações do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Retorna informações do formulário tags: – Queries x-senior-visibility: PRIVATE parameters: – name: namespace description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). in: query type: string maxLength: 100 – name: entityName description: Nome da entidade in: query required: true type: string – name: recordId description: Id in: query required: true type: integer format: int64 responses: 200: description: Ok schema: type: object required: – content properties: content: type: string format: byte description: Retorna informações do formulário 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entity_manager/queries/getRecord: post: description: Obtém o registro de Entidade de acordo com Identificador informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – View\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – View, View Data tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da Entidade id: type: string description: Identificador do registro de Entidade responses: 200: description: Ok schema: type: object required: – content properties: content: type: string format: byte description: Conteúdo do registro da Entidade 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError get: description: Obtém o registro de Entidade de acordo com Identificador informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – View\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – View, View Data tags: – Queries x-senior-visibility: PUBLIC parameters: – name: namespace description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). in: query type: string maxLength: 100 – name: entityName description: Nome da Entidade in: query required: true type: string maxLength: 100 – name: id description: Identificador do registro de Entidade in: query required: true type: string responses: 200: description: Ok schema: type: object required: – content properties: content: type: string format: byte description: Conteúdo do registro da Entidade 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /entity_manager/queries/listRecords: post: description: Retorna uma Lista de Registros da Entidade de acordo com o filtro informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – View\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – View, View Data tags: – Queries x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Entidade para buscar os registros filter: type: string description: Filtro para buscar os registros offset: type: integer format: int64 description: Faixa inicial da consulta size: type: integer format: int64 description: Quantidade de linhas da consulta maximum: 100 orderby: type: string description: Ordenação responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de Registros contents: type: array items: type: object allOf: – #/definitions/entityRecordResponse description: Lista de registros 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError get: description: Retorna uma Lista de Registros da Entidade de acordo com o filtro informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – View\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – View, View Data tags: – Queries x-senior-visibility: PUBLIC parameters: – name: namespace description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). in: query type: string maxLength: 100 – name: entityName description: Entidade para buscar os registros in: query required: true type: string maxLength: 100 – name: filter description: Filtro para buscar os registros in: query type: string – name: offset description: Faixa inicial da consulta in: query type: integer format: int64 – name: size description: Quantidade de linhas da consulta in: query type: integer format: int64 – name: orderby description: Ordenação in: query type: string responses: 200: description: Ok schema: type: object required: – totalPages – totalElements properties: totalPages: type: integer format: int64 description: Total de páginas totalElements: type: integer format: int64 description: Total de Registros contents: type: array items: type: object allOf: – #/definitions/entityRecordResponse description: Lista de registros 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /entity_manager/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 /entity_manager/queries/getDependencies: post: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError get: description: Returns a list with all dependencies from this service, along with their respective versions tags: – Queries x-senior-visibility: PUBLIC responses: 200: description: Ok schema: type: object required: – dependencies properties: dependencies: type: array items: type: object allOf: – #/definitions/dependency minimum: 1 description: List with this service dependencies 401: description: Invalid Credentials default: description: Error response schema: #/definitions/genericError /entity_manager/actions/createEntity: post: description: Cria Entidade de acordo com nome e metadados informados\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Create tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – metadata properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da entidade entityType: type: string allOf: – #/definitions/entityType description: Tipo da entidade metadata: type: string format: byte description: Metadados que descrevem a Entidade responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 409: description: Conflito, entidade com mesmo nome já existe default: description: Error response schema: #/definitions/genericError /entity_manager/actions/clearEntity: post: description: Remove todos os registros de uma Entidade de acordo com nome informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Edit\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – Edit, Edit Data tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da entidade responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /entity_manager/actions/dropEntity: post: description: Remove uma Entidade de acordo com nome informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Delete\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – Delete tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da Entidade responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /entity_manager/actions/updateMergeEntity: post: description: Atualiza os metadados de uma Entidade de acordo com o nome informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Edit\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – Edit tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – metadata properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da Entidade metadata: type: string format: byte description: Metadados que descrevem a Entidade responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /entity_manager/actions/createRecord: post: description: Criação de registro de acordo com a Entidade informada\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Edit\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – Edit, Edit Data tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – content properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da Entidade content: type: string format: byte description: Conteúdo do Registro responses: 200: description: Ok schema: type: object required: – content properties: content: type: string format: byte description: Conteúdo do Registro 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /entity_manager/actions/createRecords: post: description: Criação de registros de acordo com a Entidade informada\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Edit\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – Edit, Edit Data tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – contents properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da Entidade contents: type: array items: type: string format: byte minimum: 1 description: Conteúdo do Registro responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: string format: byte minimum: 1 description: Conteúdo do Registro 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade não encontrada default: description: Error response schema: #/definitions/genericError /entity_manager/actions/updateMergeRecord: post: description: Atualiza o registro de Entidade de acordo com o Identificador informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Edit\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – Edit, Edit Data tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – content properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da Entidade content: type: string format: byte description: Conteúdo do Registro responses: 200: description: Ok schema: type: object required: – content properties: content: type: string format: byte description: Conteúdo do Registro 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /entity_manager/actions/updateMergeRecords: post: description: Atualiza os registros de Entidade de acordo com o Identificador informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Edit\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – Edit, Edit Data tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – contents properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da Entidade contents: type: array items: type: string format: byte minimum: 1 description: Conteúdo do Registro responses: 200: description: Ok schema: type: object required: – contents properties: contents: type: array items: type: string format: byte minimum: 1 description: Conteúdo do Registro 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /entity_manager/actions/deleteRecord: post: description: Remove o registro de Entidade de acordo com o Identificador informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Edit\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – Edit, Edit Data tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – id properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da Entidade id: type: string description: Identificador do Registro responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /entity_manager/actions/deleteRecords: post: description: Remove os registros de Entidade de acordo com o Identificador informado\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Edit\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – Edit, Edit Data tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – ids properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da Entidade ids: type: array items: type: string minimum: 1 description: Identificador do Registro responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericError /entity_manager/actions/deleteRecordByFormId: post: description: Remove o registro de Entidade de acordo com o identificador do formulario\n ### Resources\n – res://senior.com.br/platform/entity_manager/entity – Edit\n – res://${domain}/custom/entity_manager/${namespace}_${entity_name} – Edit, Edit Data tags: – Actions x-senior-visibility: PUBLIC parameters: – name: input in: body required: true schema: type: object required: – entityName – formId properties: namespace: type: string maxLength: 100 description: Namespace da entidade. Se não informado, é considerado o namespace padrão (default). default: default entityName: type: string maxLength: 100 description: Nome da Entidade formId: type: integer format: int64 description: Identificador do formulario responses: 200: description: Ok schema: type: object 400: description: Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente 401: description: Usuário ou senha inválido 403: description: Permissão negada 404: description: Entidade ou Registro não encontrado default: description: Error response schema: #/definitions/genericErrordefinitions: upDown: description: Up or down type: string enum: – UP – DOWN entityType: description: Tabela ou Formulário type: string enum: – TABLE – FORM 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 checkData: description: Dados do healthcheck type: object required: – name – status properties: name: type: string description: Nome do healthcheck status: type: string allOf: – #/definitions/upDown description: Status do healthcheck entityResponse: description: Objeto com Nome e Metadados da Entidade type: object required: – name – entityType – createdBy – createdAt – updatedBy – updatedAt – resourceUri – metadata properties: name: type: string description: Nome da entidade entityType: type: string description: Tipo da entidade createdBy: type: string description: Nome do criador createdAt: type: string format: date-time description: Nome do criador updatedBy: type: string description: Nome do criador updatedAt: type: string format: date-time description: Nome do criador resourceUri: type: string description: Uri do recurso de permissão da entidade metadata: type: string format: byte description: Metadados que descrevem a entidade entityRecordResponse: description: Registro de Entidade type: object required: – content properties: content: type: string format: byte description: Conteúdo do registro notifyUserEventPayload: description: Represents a regular user event notification payload discriminator: _discriminator type: object required: – notificationKind – notificationPriority – notificationSubject – notificationContent – sourceDomain – sourceService – destinationUser – _discriminator properties: notificationClass: type: string description: Class of notification notificationOrigin: type: string description: Origin of notification. Free text. Optional. notificationKind: type: string allOf: – #/definitions/userNotificationKind description: Notification kind. notificationPriority: type: string allOf: – #/definitions/userNotificationPriority description: Notification priority. notificationSubject: type: string description: Notification subject. notificationContent: type: string description: Notification content. sourceDomain: type: string description: Domain that generates the notification. sourceService: type: string description: Service that generates the notification. destinationUser: type: string description: Username of the destination user. link: type: string description: Notification link _discriminator: type: string description: emailNotifyUserEventPayload: description: Represents an email notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – from properties: from: type: string description: Email sender address sendTo: type: array items: type: string description: Additional recipients to send the email to format: type: string allOf: – #/definitions/eventEmailFormat description: Email format pushNotifyUserEventPayload: description: Represents a push notification payload allOf: – #/definitions/notifyUserEventPayload – type: object required: – applicationId properties: applicationId: type: string description: Apple/Google application id blobReference: description: Default blob reference type. Every service defines its own. type: object required: – targetObjectId properties: domainName: type: string description: The domain the blob belongs to. serviceName: type: string description: The service the blob belongs to. targetObjectId: type: string description: The basic id of the blob. targetCopyId: type: string description: The id of the blob copy. basicErrorPayload: description: Default error payload type. Every service defines its own. type: object properties: message: type: string description: The user-facing error message, if any. errorCode: type: string description: The program-accessible (and service-specific) error code. dependency: description: Represents a service dependency type: object required: – domain – service – version properties: domain: type: string description: Domain of the dependency service service: type: string description: Name of the dependency service type: string description: Version of the dependency service genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE