Schema: Service

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
id	Yes	string
category	Yes	ServiceCategory
name	Yes	string
description	Yes	string or null
payload	Yes	RipsServiceTemplate
inputProvenance	Yes	JsonObject
isActive	Yes	boolean
createdAt	Yes	string
updatedAt	Yes	string

JSON definition

The JSON retains the source contract descriptions. Do not translate property names or enum values.

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "category": {
      "$ref": "#/components/schemas/ServiceCategory"
    },
    "name": {
      "type": "string"
    },
    "description": {
      "type": [
        "string",
        "null"
      ]
    },
    "payload": {
      "$ref": "#/components/schemas/RipsServiceTemplate"
    },
    "inputProvenance": {
      "$ref": "#/components/schemas/JsonObject"
    },
    "isActive": {
      "type": "boolean"
    },
    "createdAt": {
      "type": "string",
      "description": "Fecha y hora ISO 8601 (UTC).",
      "example": "2026-10-15T12:00:00.000Z"
    },
    "updatedAt": {
      "type": "string",
      "description": "Fecha y hora ISO 8601 (UTC).",
      "example": "2026-10-15T12:00:00.000Z"
    }
  },
  "required": [
    "id",
    "category",
    "name",
    "description",
    "payload",
    "inputProvenance",
    "isActive",
    "createdAt",
    "updatedAt"
  ]
}