{
  "opencollection": "1.0.0",
  "info": {
    "name": "Onshape REST Account Thumbnail API",
    "version": "1.218.84032-34acba44be17"
  },
  "request": {
    "auth": {
      "type": "basic",
      "username": "{{username}}",
      "password": "{{password}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Thumbnail",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get the thumbnail info for a document in the default workspace.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cad.onshape.com/api/v16/thumbnails/d/:did",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "* By default, returns thumbnail info for the element with the most-recently generated image. If you pinned an element for the document thumbnail, that element will always be used for the document-level thumbnail, if it exists in the workspace.\n* The default workspace may vary by user; the image served depends on the signed-in user.\n* See also: [Tech tip on how to change a document thumbnail in onshape](https://www.onshape.com/en/resource-center/tech-tips/tech-tip-how-to-change-a-document-thumbna"
        },
        {
          "info": {
            "name": "Get the thumbnail info for a version of a document.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cad.onshape.com/api/v16/thumbnails/d/:did/v/:vid",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path"
              },
              {
                "name": "vid",
                "value": "",
                "type": "path"
              },
              {
                "name": "linkDocumentId",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "* By default, returns thumbnail info for the element with the most-recently generated image. If you pinned an element for the document thumbnail, that element will always be used for the document-level thumbnail, if it exists in the workspace.\n* See also: [Tech tip on how to change a document thumbnail in onshape](https://www.onshape.com/en/resource-center/tech-tips/tech-tip-how-to-change-a-document-thumbnail-in-onshape)"
        },
        {
          "info": {
            "name": "Get the thumbnail info for a workspace.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cad.onshape.com/api/v16/thumbnails/d/:did/w/:wid",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path"
              },
              {
                "name": "wid",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "* By default, returns thumbnail info for the element with the most-recently generated image. If you pinned an element for the document thumbnail, that element will always be used for the document-level thumbnail, if it exists in the workspace.\n* See also: [Tech tip on how to change a document thumbnail in onshape](https://www.onshape.com/en/resource-center/tech-tips/tech-tip-how-to-change-a-document-thumbnail-in-onshape)"
        },
        {
          "info": {
            "name": "Get the thumbnail image with the given configuration for an element.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cad.onshape.com/api/v16/thumbnails/d/:did/w/:wid/e/:eid/ac/:cid/s/:sz",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path",
                "description": "The id of the document in which to perform the operation."
              },
              {
                "name": "linkDocumentId",
                "value": "",
                "type": "query",
                "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both."
              },
              {
                "name": "wid",
                "value": "",
                "type": "path",
                "description": "The id of the workspace in which to perform the operation."
              },
              {
                "name": "eid",
                "value": "",
                "type": "path",
                "description": "The id of the element in which to perform the operation."
              },
              {
                "name": "cid",
                "value": "",
                "type": "path"
              },
              {
                "name": "sz",
                "value": "300x300",
                "type": "path",
                "description": "the generated thumbnail size in pixels, widthxheigth"
              },
              {
                "name": "t",
                "value": "",
                "type": "query",
                "description": "Cache Control key. If specified, the response header returned will tell the client to use cached thumbnails."
              },
              {
                "name": "skipDefaultImage",
                "value": "",
                "type": "query",
                "description": "Controls the return of the default image, if thumbnail is not available"
              },
              {
                "name": "rejectEmpty",
                "value": "",
                "type": "query"
              },
              {
                "name": "requireConfigMatch",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns the thumbnail image for an element at a specified version, with the given configuration."
        },
        {
          "info": {
            "name": "Get the thumbnail image with the given size for a document.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cad.onshape.com/api/v16/thumbnails/d/:did/w/:wid/s/:sz",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path"
              },
              {
                "name": "wid",
                "value": "",
                "type": "path"
              },
              {
                "name": "sz",
                "value": "300x300",
                "type": "path",
                "description": "the generated thumbnail size in pixels, widthxheigth"
              },
              {
                "name": "t",
                "value": "",
                "type": "query",
                "description": "Cache Control key. If specified, the response header returned will tell the client to use cached thumbnails."
              },
              {
                "name": "skipDefaultImage",
                "value": "",
                "type": "query",
                "description": "Controls the return of the default image, if thumbnail is not available"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "* By default, returns thumbnail image for the element with the most-recently generated image. If you pinned an element for the document thumbnail, that element will always be used for the document-level thumbnail, if it exists in the workspace.\n* See also: [Tech tip on how to change a document thumbnail in onshape](https://www.onshape.com/en/resource-center/tech-tips/tech-tip-how-to-change-a-document-thumbnail-in-onshape)"
        },
        {
          "info": {
            "name": "Get the thumbnail info structure for an element.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cad.onshape.com/api/v16/thumbnails/d/:did/:wv/:wvid/e/:eid",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path",
                "description": "The id of the document in which to perform the operation."
              },
              {
                "name": "linkDocumentId",
                "value": "",
                "type": "query",
                "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both."
              },
              {
                "name": "wv",
                "value": "",
                "type": "path",
                "description": "Indicates which of workspace (w) or version (v) id is specified below."
              },
              {
                "name": "wvid",
                "value": "",
                "type": "path",
                "description": "The id of the workspace, version in which the operation should be performed."
              },
              {
                "name": "eid",
                "value": "",
                "type": "path",
                "description": "The id of the element in which to perform the operation."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Returns thumbnail info for the given document, workspace or version, and element."
        },
        {
          "info": {
            "name": "Set the thumbnail image for an application element.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://cad.onshape.com/api/v16/thumbnails/d/:did/:wv/:wvid/e/:eid",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path",
                "description": "The id of the document in which to perform the operation."
              },
              {
                "name": "linkDocumentId",
                "value": "",
                "type": "query",
                "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both."
              },
              {
                "name": "wv",
                "value": "",
                "type": "path",
                "description": "Indicates which of workspace (w) or version (v) id is specified below."
              },
              {
                "name": "wvid",
                "value": "",
                "type": "path",
                "description": "The id of the workspace, version in which the operation should be performed."
              },
              {
                "name": "eid",
                "value": "",
                "type": "path",
                "description": "The id of the element in which to perform the operation."
              },
              {
                "name": "overwrite",
                "value": "",
                "type": "query"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "* Allows 3rd-party applications to set thumbnails for their elements. \n* Application elements can have both primary and secondary thumbnails. A primary thumbnail represents the top-level of the element. A secondary thumbnail can represent sub-components of the element (e.g., a drawing sheet).\n* To update one or more thumbnails, you must set the overwrite query param to `true` and supply the entire set of thumbnails. All previous thumbnails will be deleted prior to updating the element with the l"
        },
        {
          "info": {
            "name": "Delete an element's thumbnail.",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://cad.onshape.com/api/v16/thumbnails/d/:did/:wv/:wvid/e/:eid",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path",
                "description": "The id of the document in which to perform the operation."
              },
              {
                "name": "linkDocumentId",
                "value": "",
                "type": "query",
                "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both."
              },
              {
                "name": "wv",
                "value": "",
                "type": "path",
                "description": "Indicates which of workspace (w) or version (v) id is specified below."
              },
              {
                "name": "wvid",
                "value": "",
                "type": "path",
                "description": "The id of the workspace, version in which the operation should be performed."
              },
              {
                "name": "eid",
                "value": "",
                "type": "path",
                "description": "The id of the element in which to perform the operation."
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Deletes an application element's thumbnail and images for the given document, workspace or version, and element combination."
        },
        {
          "info": {
            "name": "Get the thumbnail image with the given size for an element.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cad.onshape.com/api/v16/thumbnails/d/:did/:wv/:wvid/e/:eid/s/:sz",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path",
                "description": "The id of the document in which to perform the operation."
              },
              {
                "name": "linkDocumentId",
                "value": "",
                "type": "query",
                "description": "The id of the document through which the above document should be accessed; only applicable when accessing a version of the document. This allows a user who has access to document a to see data from document b, as long as document b has been linked to document a by a user who has permission to both."
              },
              {
                "name": "wv",
                "value": "",
                "type": "path",
                "description": "Indicates which of workspace (w) or version (v) id is specified below."
              },
              {
                "name": "wvid",
                "value": "",
                "type": "path",
                "description": "The id of the workspace, version in which the operation should be performed."
              },
              {
                "name": "eid",
                "value": "",
                "type": "path",
                "description": "The id of the element in which to perform the operation."
              },
              {
                "name": "sz",
                "value": "300x300",
                "type": "path",
                "description": "the generated thumbnail size in pixels, widthxheigth"
              },
              {
                "name": "t",
                "value": "",
                "type": "query",
                "description": "Cache Control key. If specified, the response header returned will tell the client to use cached thumbnails."
              },
              {
                "name": "skipDefaultImage",
                "value": "",
                "type": "query",
                "description": "Controls the return of the default image, if thumbnail is not available"
              },
              {
                "name": "rejectEmpty",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "Get the thumbnail image with the given size for an element."
        },
        {
          "info": {
            "name": "This endpoint will be deprecated soon. Use `getThumbnailForDocument` instead.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cad.onshape.com/api/v16/thumbnails/document/:did",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This API exists for historical reasons. It uses `/document/` in the path, rather than the standard `/d/` to specify the document."
        },
        {
          "info": {
            "name": "This endpoint will be deprecated soon. Use `getThumbnailForDocumentAndVersion` instead.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cad.onshape.com/api/v16/thumbnails/document/:did/version/:vid",
            "params": [
              {
                "name": "did",
                "value": "",
                "type": "path"
              },
              {
                "name": "vid",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "authorization_code",
              "authorizationUrl": "/oauth/authorize",
              "accessTokenUrl": "/oauth/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "This API exists for historical reasons. It uses `/document/` in the path, rather than the standard `/d/` to specify the document."
        }
      ]
    }
  ],
  "bundled": true
}