Pular para o conteúdo principal

ContractRegistrarObservation

observationIdstringobrigatório
decisionTraceabilityObservationDecision (string)obrigatório

Valores possíveis: [APPLIED, NO_CHANGE, IGNORED_DUPLICATE, IGNORED_STALE, CONFLICT, REJECTED_INVALID]

values objectobrigatório
property name*string
provenance objectobrigatório
schemaVersionintegerobrigatório

Valores possíveis: [1]

aggregateTypestringobrigatório

Valores possíveis: [CONTRACT]

aggregateIdstringobrigatório
originTypestringobrigatório

Valores possíveis: [REGISTRAR, CLIENT, BACKOFFICE, SYSTEM]

originChannelstringobrigatório

Valores possíveis: [TAG, NUCLEA, CONTROL_PANEL, API_V2, BACKOFFICE_API, WORKER, MIGRATION]

actorTypestringobrigatório

Valores possíveis: [PROVIDER, USER, SERVICE]

actorIdstring
actorRolestring
clientIdstring
tenantIdstring

Canonical tenant associated with an API V2 service actor. Optional for historical provenance and actor types that predate this route-scoped requirement.

companyTaxIdstring
registrarstring

Valores possíveis: [TAG, NUCLEA]

providerEventIdstring
providerObjectIdstring
providerVersionstring
providerSequencestring
orderBasisstring

Valores possíveis: [PROVIDER_SEQUENCE, PROVIDER_VERSION, EFFECTIVE_AT, RECEIVED_AT]

occurredAtstring<date-time>obrigatório
effectiveAtstring<date-time>
receivedAtstring<date-time>obrigatório
appliedAtstring<date-time>
correlationIdstringobrigatório
causationIdstring
commandIdstring
operationIdstring
reasonCodestring
relatedObservationIdsstring[]

Identificadores de observações imutáveis considerados em uma resolução de conflito do backoffice.

Valores possíveis: <= 20

versioninteger<int64>obrigatório
historicalCompletenessstringobrigatório

Valores possíveis: [COMPLETE_FROM_CREATION, FROM_BASELINE]

ContractRegistrarObservation
{
  "observationId": "string",
  "decision": "APPLIED",
  "values": {},
  "provenance": {
    "schemaVersion": 1,
    "aggregateType": "CONTRACT",
    "aggregateId": "string",
    "originType": "REGISTRAR",
    "originChannel": "TAG",
    "actorType": "PROVIDER",
    "actorId": "string",
    "actorRole": "string",
    "clientId": "string",
    "tenantId": "string",
    "companyTaxId": "string",
    "registrar": "TAG",
    "providerEventId": "string",
    "providerObjectId": "string",
    "providerVersion": "string",
    "providerSequence": "string",
    "orderBasis": "PROVIDER_SEQUENCE",
    "occurredAt": "2024-07-29T15:51:28.071Z",
    "effectiveAt": "2024-07-29T15:51:28.071Z",
    "receivedAt": "2024-07-29T15:51:28.071Z",
    "appliedAt": "2024-07-29T15:51:28.071Z",
    "correlationId": "string",
    "causationId": "string",
    "commandId": "string",
    "operationId": "string",
    "reasonCode": "string",
    "relatedObservationIds": [
      "string"
    ],
    "version": 0,
    "historicalCompleteness": "COMPLETE_FROM_CREATION"
  }
}