---
title: Get revision
slug: model-api/get-revision
docTags: 
createdAt: 2024-06-10T16:48:45.445Z
---

{
  "id": "Whpnrs18113P_dC8_xFqh",
  "type": "api-oas-v2",
  "data": {
    "method": "GET",
    "url": "https://api.catenda.com/v2/projects/{project-id}/revisions/{model-revision-id}",
    "servers": [
      {
        "url": "https://api.catenda.com/v2/projects/{project-id}/revisions/{model-revision-id}"
      }
    ],
    "name": "Get revision",
    "description": "<p>Get a revision of an IFC model.</p>\n<p>By default returns the revision details as JSON.</p>\n<p>To download the revision use <strong>Content-Type: application/ifc</strong> in request headers.</p>",
    "contentType": "application/json",
    "request": {
      "pathParameters": [
        {
          "kind": "required",
          "name": "project-id",
          "type": "string",
          "example": "af2d8af0fa54465b89bf26dd3d92cfd0",
          "description": "Catenda project id"
        },
        {
          "kind": "required",
          "name": "model-revision-id",
          "type": "string",
          "description": "Id of the model revision"
        }
      ],
      "headerParameters": [
        {
          "name": "accept",
          "type": "string",
          "kind": "optional",
          "description": "Generated from available response content types",
          "enum": [
            "application/json",
            "application/ifc"
          ],
          "default": "application/json"
        }
      ],
      "queryParameters": [
        {
          "kind": "optional",
          "name": "normalize",
          "type": "string",
          "description": "<p>Applies to IFC downloads. By default, STEP instance names correspond to their Catenda object id, by setting <code>true</code> the STEP instance names will instead start at #1.</p>"
        }
      ],
      "bodyDataParameters": [],
      "formDataParameters": [],
      "oAuthParameters": [
        {
          "id": "Bearer",
          "name": "Bearer",
          "kind": "optional",
          "type": "http",
          "scheme": "bearer"
        }
      ],
      "cookieParameters": []
    },
    "responses": [
      {
        "statusCode": "200",
        "description": "OK",
        "jsonExample": "",
        "isExpanded": true,
        "schema": [
          {
            "kind": "optional",
            "type": "object",
            "description": "Represents a revision of a Model.\n\nA new revision is created by uploading an IFC model.\n",
            "customType": "model-revision",
            "schema": [
              {
                "name": "comment",
                "kind": "optional",
                "type": "string",
                "description": "<p>Text describing the revision, limited to 64K characters</p>",
                "example": "Revision description"
              },
              {
                "name": "createdAt",
                "kind": "optional",
                "type": "string",
                "description": "The date and time the revision was created in ISO 8601 format",
                "example": "2016-09-26T14:45:20.000Z"
              },
              {
                "name": "extendedVersion",
                "kind": "optional",
                "type": "object",
                "description": "Extended version of the revision",
                "example": "",
                "schema": [
                  {
                    "name": "major",
                    "kind": "optional",
                    "type": "number",
                    "description": "Major version of the revision",
                    "example": 1
                  },
                  {
                    "name": "minor",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "Minor version of the revision",
                    "example": 1
                  }
                ]
              },
              {
                "name": "id",
                "kind": "optional",
                "type": "string",
                "description": "<p>A unique identifier for the revision, represented as compacted UUID using 32 hexadecimal characters.</p>",
                "example": "924809076a694255c489d236517a55da"
              },
              {
                "name": "model",
                "kind": "optional",
                "type": "object",
                "description": "<p>Represents an IFC model as a set of Revisions.</p>\n<p>A large building project can contain multiple IFC models.</p>\n<p>They are often divided by domain (architecture, electrical, etc.)</p>",
                "modelRef": "#/components/schemas/model",
                "customType": "model",
                "schema": [
                  {
                    "name": "id",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>A unique identifier for a model, represented as compacted UUID using 32 hexadecimal characters</p>",
                    "example": "47024671cbd642a9c7c84808d4d509f5"
                  },
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>The name of the model, limited to 512 characters</p>",
                    "example": "Model name"
                  }
                ]
              },
              {
                "name": "user",
                "kind": "optional",
                "type": "object",
                "description": "<p>Represents a User, Organization or Team.</p>\n<p>A User is someone with a Catenda account, commonly representing a person.</p>\n<p>An Organization represents a company, project organization or an application. Organizations do not have a username and cannot sign in to Catenda.</p>\n<p>A Team represents a group of users within a project. Teams do not have a username and cannot sign in to Catenda.</p>",
                "modelRef": "#/components/schemas/user",
                "customType": "user",
                "schema": [
                  {
                    "name": "id",
                    "kind": "optional",
                    "type": "string",
                    "description": "Represented as compacted UUID using 32 hexadecimal characters",
                    "example": "524809076a694255b989d236517a55da"
                  },
                  {
                    "name": "name",
                    "kind": "optional",
                    "type": "string",
                    "description": "<p>The name of the user, limited to 128 characters</p>",
                    "example": "John Doe"
                  },
                  {
                    "name": "username",
                    "kind": "optional",
                    "type": "string",
                    "nullable": true,
                    "description": "<p>The handle the user identifies with.</p>\n<p>Commonly the username will be in email address format. Usernames are unique but subject to change, we recommend using the id field to reference users instead.</p>\n<p>If the user represents an organization or a team the value is always null.</p>\n<p>Limited to 50 characters.</p>",
                    "example": "john@doe.com"
                  },
                  {
                    "name": "email",
                    "kind": "optional",
                    "type": "string",
                    "description": "Email address of the User",
                    "example": "john@doe.com"
                  },
                  {
                    "name": "createdAt",
                    "kind": "optional",
                    "type": "string",
                    "description": "The date and time the user was created in ISO 8601 format",
                    "example": "2016-09-20T14:55:22.000Z"
                  },
                  {
                    "name": "avatarUrl",
                    "kind": "optional",
                    "type": "string",
                    "description": "The URL for the user avatar",
                    "example": "https://api.catenda.com/v2/avatar/397t0ccd8f74516096c738de15dc6512"
                  },
                  {
                    "name": "type",
                    "kind": "optional",
                    "type": "string<user | organization | team>",
                    "description": "<p>The type of user, valid values are:</p>\n<ul>\n<li>user</li>\n<li>organization</li>\n<li>team</li>\n</ul>",
                    "example": "user",
                    "enum": [
                      "user",
                      "organization",
                      "team"
                    ]
                  }
                ]
              },
              {
                "name": "version",
                "kind": "optional",
                "type": "integer",
                "description": "A number that is incremented for each new revision of a model",
                "example": 1
              }
            ],
            "modelRef": "#/components/schemas/model-revision",
            "isExpanded": true
          }
        ]
      }
    ],
    "hasXCodeSamples": false,
    "examples": {
      "languages": [
        {
          "id": "yPcyUTYrntzLcnoHvxmYC",
          "language": "curl",
          "label": "cURL",
          "code": "curl --request GET \\\n     --url https://api.catenda.com/v2/projects/{project-id}/revisions/{model-revision-id} \\\n     --header 'accept: application/json'"
        },
        {
          "id": "X-bOcfCp23i2IKMRBPVZ3",
          "language": "javascript",
          "label": "javascript",
          "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n   method: 'GET',\n   headers: myHeaders,\n   redirect: 'follow'\n};\n\nfetch(\"https://api.catenda.com/v2/projects/{project-id}/revisions/{model-revision-id}\", requestOptions)\n   .then(response => response.text())\n   .then(result => console.log(result))\n   .catch(error => console.log('error', error));"
        },
        {
          "id": "6mR7eDpSI1rLDElyBqWTt",
          "language": "ruby",
          "label": "Ruby",
          "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.catenda.com/v2/projects/{project-id}/revisions/{model-revision-id}\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n"
        },
        {
          "id": "mUJjcIh33z3pYGbotTWhU",
          "language": "python",
          "label": "Python",
          "code": "import requests\nimport json\n\nurl = \"https://api.catenda.com/v2/projects/{project-id}/revisions/{model-revision-id}\"\n\npayload = {}\nheaders = {\n   'accept': 'application/json',\n   'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n"
        }
      ],
      "selectedLanguageId": "yPcyUTYrntzLcnoHvxmYC"
    },
    "results": {
      "languages": [
        {
          "id": "OoIF1LGpG8BRZJqPSBCEi",
          "language": "200",
          "code": "// OK\n{\n  \"comment\": \"Revision description\",\n  \"createdAt\": \"2016-09-26T14:45:20.000Z\",\n  \"extendedVersion\": {\n    \"major\": 1,\n    \"minor\": 1\n  },\n  \"id\": \"924809076a694255c489d236517a55da\",\n  \"model\": {\n    \"id\": \"47024671cbd642a9c7c84808d4d509f5\",\n    \"name\": \"Model name\"\n  },\n  \"user\": {\n    \"id\": \"524809076a694255b989d236517a55da\",\n    \"name\": \"John Doe\",\n    \"username\": \"john@doe.com\",\n    \"email\": \"john@doe.com\",\n    \"createdAt\": \"2016-09-20T14:55:22.000Z\",\n    \"avatarUrl\": \"https://api.catenda.com/v2/avatar/397t0ccd8f74516096c738de15dc6512\",\n    \"type\": \"user\"\n  },\n  \"version\": 1\n}"
        }
      ],
      "selectedLanguageId": "OoIF1LGpG8BRZJqPSBCEi"
    }
  },
  "children": [
    {
      "text": ""
    }
  ]
}