get-commitment

restish dci get-commitment id

Returns a commitment by the specified Id.

Responses

200 (application/json)

OK - Commitment returned.

{
  "type": "object",
  "description": "A commitment contract.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier of the commitment."
    },
    "name": {
      "type": "string",
      "description": "The name of the commitment."
    },
    "startDate": {
      "type": "string",
      "format": "date-time",
      "example": "2024-03-10T23:00:00Z",
      "description": "The start date of the commitment."
    },
    "endDate": {
      "type": "string",
      "format": "date-time",
      "example": "2024-03-10T23:00:00Z",
      "description": "The end date of the commitment."
    },
    "currency": {
      "type": "string",
      "description": "The currency of the commitment (e.g., USD).",
      "example": "USD"
    },
    "cloudProvider": {
      "type": "string",
      "description": "The cloud provider associated with the commitment.",
      "enum": [
        "google-cloud",
        "amazon-web-services",
        "microsoft-azure"
      ]
    },
    "totalCommitmentValue": {
      "type": "number",
      "format": "double",
      "description": "The total value of the commitment across all periods."
    },
    "totalCurrentAttainment": {
      "type": "number",
      "format": "double",
      "description": "The total current spend attainment across all periods."
    },
    "periods": {
      "type": "array",
      "description": "The list of commitment periods.",
      "items": {
        "type": "object",
        "description": "A single period within a commitment.",
        "properties": {
          "startDate": {
            "type": "string",
            "format": "date-time",
            "example": "2024-03-10T23:00:00Z",
            "description": "The start date of the period."
          },
          "endDate": {
            "type": "string",
            "format": "date-time",
            "example": "2024-03-10T23:00:00Z",
            "description": "The end date of the period."
          },
          "commitmentValue": {
            "type": "number",
            "format": "double",
            "description": "The commitment value for this period."
          },
          "marketplaceLimitPercentage": {
            "type": "number",
            "format": "double",
            "description": "The marketplace limit as a percentage (0-100)."
          }
        }
      }
    },
    "createTime": {
      "type": "integer",
      "format": "int64",
      "description": "The creation time in milliseconds since epoch."
    },
    "updateTime": {
      "type": "integer",
      "format": "int64",
      "description": "The last update time in milliseconds since epoch."
    }
  }
}

400 (application/json)

Bad Request - The server cannot process the request, often due to a malformed request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

401 (application/json)

Unauthorized - Invalid API key.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

403 (application/json)

Forbidden - The client is not authorized to perform the request.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

404 (application/json)

Not Found - The requested resource does not exist.

{
  "type": "object",
  "description": "Standard error response structure.",
  "properties": {
    "error": {
      "type": "string",
      "description": "Detailed error message."
    }
  }
}

Aliases: get-commitment, getcommitment