{ "info": { "_postman_id": "a191eb44-89ea-426c-9ccf-0374eb0cab4e", "name": "Laserfiche Repository API v1", "description": "Welcome to the Laserfiche API Swagger Playground. You can try out any of our API calls against your live Laserfiche Cloud account. Visit the developer center for more details: https://developer.laserfiche.com

Visit the changelog for the list of changes: /repository/v1/changelog

Build# : 69c7f337a8ae3b90af88dc1080328c042d5a13df_.20240411.1

", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "35177085" }, "item": [ { "name": "v1", "item": [ { "name": "Repositories", "item": [ { "name": "{repoId}", "item": [ { "name": "Entries", "item": [ { "name": "{parentEntryId}", "item": [ { "name": "{fileName}", "item": [ { "name": "Creates a new document in a folder.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "electronicDocument", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:parentEntryId/:fileName?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":parentEntryId", ":fileName" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "parentEntryId", "value": "", "description": "(Required) The entry ID of the folder that the document will be created in." }, { "key": "fileName", "value": "", "description": "(Required) The created document's file name." } ] }, "description": "- Creates a new document in the specified folder with file (no more than 100 MB).\n- File parameter electronicDocument is required, but can be an empty file (e.g., a text file of 0 byte in size) to create a blank document.\n- Optionally sets metadata.\n- Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.\n- With this route, partial success is possible. The response returns multiple operation (entryCreate operation, setEdoc operation, setLinks operation, etc..) objects, which contain information about any errors that may have occurred during the creation. As long as the entryCreate operation succeeds, the entry will be created, even if all other operations fail.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Document creation is success.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "electronicDocument", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:parentEntryId/:fileName?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":parentEntryId", ":fileName" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "parentEntryId" }, { "key": "fileName" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operations\": {\n \"entryCreate\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"entryId\": \"\"\n },\n \"setEdoc\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ]\n },\n \"setTemplate\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"template\": \"\"\n },\n \"setFields\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"fieldCount\": \"\"\n },\n \"setTags\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"assignedTags\": [\n \"\",\n \"\"\n ]\n },\n \"setLinks\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"otherEntryIds\": [\n \"\",\n \"\"\n ]\n }\n },\n \"documentLink\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "electronicDocument", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:parentEntryId/:fileName?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":parentEntryId", ":fileName" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "parentEntryId" }, { "key": "fileName" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operations\": {\n \"entryCreate\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"entryId\": \"\"\n },\n \"setEdoc\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ]\n },\n \"setTemplate\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"template\": \"\"\n },\n \"setFields\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"fieldCount\": \"\"\n },\n \"setTags\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"assignedTags\": [\n \"\",\n \"\"\n ]\n },\n \"setLinks\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"otherEntryIds\": [\n \"\",\n \"\"\n ]\n }\n },\n \"documentLink\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "electronicDocument", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:parentEntryId/:fileName?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":parentEntryId", ":fileName" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "parentEntryId" }, { "key": "fileName" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "electronicDocument", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:parentEntryId/:fileName?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":parentEntryId", ":fileName" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "parentEntryId" }, { "key": "fileName" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Parent entry is not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "electronicDocument", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:parentEntryId/:fileName?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":parentEntryId", ":fileName" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "parentEntryId" }, { "key": "fileName" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operations\": {\n \"entryCreate\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"entryId\": \"\"\n },\n \"setEdoc\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ]\n },\n \"setTemplate\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"template\": \"\"\n },\n \"setFields\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"fieldCount\": \"\"\n },\n \"setTags\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"assignedTags\": [\n \"\",\n \"\"\n ]\n },\n \"setLinks\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"otherEntryIds\": [\n \"\",\n \"\"\n ]\n }\n },\n \"documentLink\": \"\"\n}" }, { "name": "Document creation is partial success.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "electronicDocument", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:parentEntryId/:fileName?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":parentEntryId", ":fileName" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "parentEntryId" }, { "key": "fileName" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operations\": {\n \"entryCreate\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"entryId\": \"\"\n },\n \"setEdoc\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ]\n },\n \"setTemplate\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"template\": \"\"\n },\n \"setFields\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"fieldCount\": \"\"\n },\n \"setTags\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"assignedTags\": [\n \"\",\n \"\"\n ]\n },\n \"setLinks\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"otherEntryIds\": [\n \"\",\n \"\"\n ]\n }\n },\n \"documentLink\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "electronicDocument", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:parentEntryId/:fileName?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":parentEntryId", ":fileName" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "parentEntryId" }, { "key": "fileName" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "electronicDocument", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:parentEntryId/:fileName?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":parentEntryId", ":fileName" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "parentEntryId" }, { "key": "fileName" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Document creation is complete failure.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "formdata", "formdata": [ { "key": "electronicDocument", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:parentEntryId/:fileName?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":parentEntryId", ":fileName" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new document should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "parentEntryId" }, { "key": "fileName" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operations\": {\n \"entryCreate\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"entryId\": \"\"\n },\n \"setEdoc\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ]\n },\n \"setTemplate\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"template\": \"\"\n },\n \"setFields\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"fieldCount\": \"\"\n },\n \"setTags\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"assignedTags\": [\n \"\",\n \"\"\n ]\n },\n \"setLinks\": {\n \"exceptions\": [\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n },\n {\n \"operationId\": \"\",\n \"message\": \"\",\n \"errorCode\": \"\",\n \"errorClass\": \"\",\n \"statusCode\": \"\",\n \"errorSource\": \"\"\n }\n ],\n \"otherEntryIds\": [\n \"\",\n \"\"\n ]\n }\n },\n \"documentLink\": \"\"\n}" } ] } ] } ] }, { "name": "{entryId}", "item": [ { "name": "Laserfiche.Repository.Folder", "item": [ { "name": "children", "item": [ { "name": "Returns the children entries of a folder.", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?groupByEntryType=&fields=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry. " }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The folder ID." } ] }, "description": "- Returns the children entries of a folder in the repository.\n- Provide an entry ID (must be a folder), and get a paged listing of entries in that folder. Used as a way of navigating through the repository.\n- Entries returned in the listing are not automatically converted to their subtype (Folder, Shortcut, Document), so clients who want model-specific information should request it via the GET entry by ID route.\n- Optional query parameters: groupByEntryType (bool). This query parameter decides if results are returned in groups based on their entry type. \n- Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.\n- Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: \"PropertyName direction,PropertyName2 direction\". Sort order can be either value \"asc\" or \"desc\".\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get the children entries of a Folder successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?groupByEntryType=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?groupByEntryType=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?groupByEntryType=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?groupByEntryType=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?groupByEntryType=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?groupByEntryType=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] }, { "name": "Creates/copies a new child entry in a folder.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"entryType\": \"Folder\",\n \"targetId\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The folder ID that the entry will be created in." } ] }, "description": "- Create/copy a new child entry in the designated folder.\n- Provide the parent folder ID, and based on the request body, copy or create a folder/shortcut as a child entry of the designated folder.\n- Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Created a new child entry successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"entryType\": \"Folder\",\n \"targetId\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"fullPath\": \"\",\n \"folderPath\": \"\",\n \"creator\": \"\",\n \"creationTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"entryType\": \"Shortcut\",\n \"isContainer\": \"\",\n \"isLeaf\": \"\",\n \"templateName\": \"\",\n \"templateId\": \"\",\n \"templateFieldNames\": [\n \"\",\n \"\"\n ],\n \"volumeName\": \"\",\n \"rowNumber\": \"\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"veniam3\": {},\n \"dolorc\": {},\n \"ad6cd\": {},\n \"dolorea\": {}\n },\n {\n \"enim95d\": {}\n }\n ],\n \"fieldType\": \"DateTime\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"quis8\": {}\n },\n {\n \"esse_e\": {}\n }\n ],\n \"fieldType\": \"Time\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n }\n ]\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"entryType\": \"Folder\",\n \"targetId\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"entryType\": \"Folder\",\n \"targetId\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"entryType\": \"Folder\",\n \"targetId\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"entryType\": \"Folder\",\n \"targetId\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry name conflicts.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"entryType\": \"Folder\",\n \"targetId\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"entryType\": \"Folder\",\n \"targetId\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"entryType\": \"Folder\",\n \"targetId\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/children?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "children" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "CopyAsync", "item": [ { "name": "Copies an entry into a folder asynchronously.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/CopyAsync?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "CopyAsync" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The folder ID that the entry will be created in." } ] }, "description": "- Copy a new child entry in the designated folder async, and potentially return an operationToken.\n- Provide the parent folder ID, and copy an entry as a child of the designated folder.\n- Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed. \n- The status of the operation can be checked via the Tasks/{operationToken} route.\n- Token substitution in the name of the copied entry is not supported.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Copy entry operation is started successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/CopyAsync?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "CopyAsync" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"token\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/CopyAsync?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "CopyAsync" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/CopyAsync?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "CopyAsync" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/CopyAsync?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "CopyAsync" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/CopyAsync?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "CopyAsync" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/CopyAsync?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "CopyAsync" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Operation limit or request limit reached.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"sourceId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Folder/CopyAsync?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Folder", "CopyAsync" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the new entry should be automatically renamed if an entry already exists with the given name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] } ] }, { "name": "fields", "item": [ { "name": "GetDynamicFieldLogicValue", "item": [ { "name": "Returns the dynamic field logic values assigned to an entry.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"templateId\": \"\",\n \"fieldValues\": {\n \"amet9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Returns dynamic field logic values with the current values of the fields in the template.\n- Provide an entry ID and field values in the JSON body to get dynamic field logic values.\n- Independent and non-dynamic fields in the request body will be ignored, and only related dynamic field logic values for the assigned template will be returned.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get dynamic field logic values successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateId\": \"\",\n \"fieldValues\": {\n \"amet9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"officia_547\": [\n \"\",\n \"\"\n ]\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateId\": \"\",\n \"fieldValues\": {\n \"amet9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateId\": \"\",\n \"fieldValues\": {\n \"amet9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateId\": \"\",\n \"fieldValues\": {\n \"amet9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateId\": \"\",\n \"fieldValues\": {\n \"amet9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateId\": \"\",\n \"fieldValues\": {\n \"amet9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateId\": \"\",\n \"fieldValues\": {\n \"amet9\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Returns the fields assigned to an entry.", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?formatValue=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "formatValue", "value": "false", "description": "An optional query parameter used to indicate if the field values should be formatted. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Returns the fields assigned to an entry.\n- Provide an entry ID, and get a paged listing of all fields assigned to that entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get field values successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?formatValue=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "formatValue", "value": "false", "description": "An optional query parameter used to indicate if the field values should be formatted. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?formatValue=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "formatValue", "value": "false", "description": "An optional query parameter used to indicate if the field values should be formatted. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?formatValue=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "formatValue", "value": "false", "description": "An optional query parameter used to indicate if the field values should be formatted. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?formatValue=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "formatValue", "value": "false", "description": "An optional query parameter used to indicate if the field values should be formatted. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?formatValue=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "formatValue", "value": "false", "description": "An optional query parameter used to indicate if the field values should be formatted. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?formatValue=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "formatValue", "value": "false", "description": "An optional query parameter used to indicate if the field values should be formatted. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatValue query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] }, { "name": "Updates the field values assigned to an entry.", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"adipisicing_8\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nulla_3\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"est7\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"mollit39\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The entry ID of the entry that will have its fields updated." } ] }, "description": "- Update the field values assigned to an entry.\n- Provide the new field values to assign to the entry, and remove/reset all previously assigned field values.\n- This is an overwrite action. The request body must include all desired field values, including any existing field values that should remain assigned to the entry. Field values that are not included in the request will be deleted from the entry. If the field value that is not included is part of a template, it will still be assigned (as required by the template), but its value will be reset.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Update field values successfully.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"adipisicing_8\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nulla_3\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"est7\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"mollit39\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"adipisicing_8\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nulla_3\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"est7\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"mollit39\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"adipisicing_8\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nulla_3\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"est7\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"mollit39\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"adipisicing_8\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nulla_3\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"est7\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"mollit39\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Requested entry id not found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"adipisicing_8\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nulla_3\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"est7\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"mollit39\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"adipisicing_8\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nulla_3\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"est7\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"mollit39\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry is locked.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"adipisicing_8\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nulla_3\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"est7\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"mollit39\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"adipisicing_8\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nulla_3\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"est7\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"mollit39\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "tags", "item": [ { "name": "Returns the tags assigned to an entry.", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Returns the tags assigned to an entry.\n- Provide an entry ID, and get a paged listing of tags assigned to that entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get entry tags successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] }, { "name": "Assigns tags to an entry.", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Assign tags to an entry.\n- Provide an entry ID and a list of tags to assign to that entry.\n- This is an overwrite action. The request must include all tags to assign to the entry, including existing tags that should remain assigned to the entry.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Assign tags to an entry successfully.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"isSecure\": \"\",\n \"watermark\": {\n \"watermarkText\": \"\",\n \"watermarkTextSize\": \"\",\n \"watermarkPosition\": \"DeadCenter\",\n \"watermarkRotationAngle\": \"\",\n \"isWatermarkMandatory\": \"\",\n \"watermarkIntensity\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"isSecure\": \"\",\n \"watermark\": {\n \"watermarkText\": \"\",\n \"watermarkTextSize\": \"\",\n \"watermarkPosition\": \"BottomLeft\",\n \"watermarkRotationAngle\": \"\",\n \"isWatermarkMandatory\": \"\",\n \"watermarkIntensity\": \"\"\n }\n }\n ]\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request id not found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry is locked.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"tags\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/tags", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "tags" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "links", "item": [ { "name": "Assigns links to an entry.", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"labore_6\": \"\",\n \"consectetur__\": \"\",\n \"minim_\": \"\"\n }\n },\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"sunteea\": \"\",\n \"incididunta\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The request repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Assign links to an entry.\n- Provide an entry ID and a list of links to assign to that entry.\n- This is an overwrite action. The request must include all links to assign to the entry, including existing links that should remain assigned to the entry.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Assign links to an entry successfully.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"labore_6\": \"\",\n \"consectetur__\": \"\",\n \"minim_\": \"\"\n }\n },\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"sunteea\": \"\",\n \"incididunta\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": [\n {\n \"linkId\": \"\",\n \"sourceId\": \"\",\n \"sourceFullPath\": \"\",\n \"sourceLabel\": \"\",\n \"targetId\": \"\",\n \"targetFullPath\": \"\",\n \"targetLabel\": \"\",\n \"description\": \"\",\n \"linkTypeDescription\": \"\",\n \"linkTypeId\": \"\",\n \"linkProperties\": {\n \"sit_9a\": \"\",\n \"nulla_ef\": \"\",\n \"minimbd3\": \"\",\n \"ad_41\": \"\"\n },\n \"sourceLink\": \"\",\n \"targetLink\": \"\"\n },\n {\n \"linkId\": \"\",\n \"sourceId\": \"\",\n \"sourceFullPath\": \"\",\n \"sourceLabel\": \"\",\n \"targetId\": \"\",\n \"targetFullPath\": \"\",\n \"targetLabel\": \"\",\n \"description\": \"\",\n \"linkTypeDescription\": \"\",\n \"linkTypeId\": \"\",\n \"linkProperties\": {\n \"qui47\": \"\"\n },\n \"sourceLink\": \"\",\n \"targetLink\": \"\"\n }\n ]\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"labore_6\": \"\",\n \"consectetur__\": \"\",\n \"minim_\": \"\"\n }\n },\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"sunteea\": \"\",\n \"incididunta\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"labore_6\": \"\",\n \"consectetur__\": \"\",\n \"minim_\": \"\"\n }\n },\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"sunteea\": \"\",\n \"incididunta\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"labore_6\": \"\",\n \"consectetur__\": \"\",\n \"minim_\": \"\"\n }\n },\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"sunteea\": \"\",\n \"incididunta\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"labore_6\": \"\",\n \"consectetur__\": \"\",\n \"minim_\": \"\"\n }\n },\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"sunteea\": \"\",\n \"incididunta\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"labore_6\": \"\",\n \"consectetur__\": \"\",\n \"minim_\": \"\"\n }\n },\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"sunteea\": \"\",\n \"incididunta\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry is locked.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"labore_6\": \"\",\n \"consectetur__\": \"\",\n \"minim_\": \"\"\n }\n },\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"sunteea\": \"\",\n \"incididunta\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "[\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"labore_6\": \"\",\n \"consectetur__\": \"\",\n \"minim_\": \"\"\n }\n },\n {\n \"targetId\": \"\",\n \"linkTypeId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"sunteea\": \"\",\n \"incididunta\": \"\"\n }\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] }, { "name": "Returns the links assigned to an entry.", "request": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Returns the links assigned to an entry.\n- Provide an entry ID, and get a paged listing of links assigned to that entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get links successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "links" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Laserfiche.Repository.Document", "item": [ { "name": "edoc", "item": [ { "name": "Deletes the edoc associated with an entry.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested document ID." } ] }, "description": "- Delete the edoc associated with the provided entry ID.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Deleted edoc successfully.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry is locked.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] }, { "name": "Returns information about the edoc content of an entry.", "request": { "method": "HEAD", "header": [], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested document ID." } ] }, "description": "- Returns information about the edoc content of an entry, without downloading the edoc in its entirety.\n- Provide an entry ID, and get back the mime-type and the length of the corresponding edoc, respectively in the Content-Type and X-APIServer-ContentLength HTTP response headers.\n- This route does not provide a way to download the actual edoc. Instead, it just gives metadata information about the edoc associated with the entry.\n- If an error occurs, the error message can be found in the X-APIServer-Error HTTP response header.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get edoc info successfully.", "originalRequest": { "method": "HEAD", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "HEAD", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "HEAD", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "HEAD", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Request entry id not found.", "originalRequest": { "method": "HEAD", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Entry is locked.", "originalRequest": { "method": "HEAD", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "HEAD", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" } ] }, { "name": "Returns an entry's edoc resource in a stream format.", "request": { "method": "GET", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Accept", "value": "application/octet-stream" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested document ID." } ] }, "description": "- Returns an entry's edoc resource in a stream format.\n- Provide an entry ID, and get the edoc resource as part of the response content.\n- Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get edoc successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Accept", "value": "application/octet-stream" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" }, { "name": "Get edoc range successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Accept", "value": "application/octet-stream" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Partial Content", "code": 206, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry is locked.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/edoc", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "edoc" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "pages", "item": [ { "name": "Deletes the pages associated with an entry.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested document ID." } ] }, "description": "- Delete the pages associated with the provided entry ID. If no pageRange is specified, all pages will be deleted.\n- Optional parameter: pageRange (default empty). The value should be a comma-separated string which contains non-overlapping single values, or page ranges. Ex: \"1,2,3\", \"1-3,5\", \"2-7,10-12.\"\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Deleted pages successfully.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry is locked.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "GetEdocWithAuditReason", "item": [ { "name": "Returns an entry's edoc resource in a stream format, including an audit reason.", "request": { "method": "POST", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/octet-stream" } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/GetEdocWithAuditReason", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "GetEdocWithAuditReason" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested document ID." } ] }, "description": "- Returns an entry's edoc resource in a stream format while including an audit reason.\n- Provide an entry ID and audit reason/comment in the request body, and get the edoc resource as part of the response content.\n- Optional header: Range. Use the Range header (single range with byte unit) to retrieve partial content of the edoc, rather than the entire edoc.\n- This route is identical to the GET edoc route, but allows clients to include an audit reason when downloading the edoc.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get edoc successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/octet-stream" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/GetEdocWithAuditReason", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "GetEdocWithAuditReason" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" }, { "name": "Get edoc range successfully.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/octet-stream" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/GetEdocWithAuditReason", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "GetEdocWithAuditReason" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Partial Content", "code": 206, "_postman_previewlanguage": "text", "header": [ { "key": "Content-Type", "value": "application/octet-stream" } ], "cookie": [], "body": "" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/GetEdocWithAuditReason", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "GetEdocWithAuditReason" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/GetEdocWithAuditReason", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "GetEdocWithAuditReason" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/GetEdocWithAuditReason", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "GetEdocWithAuditReason" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/GetEdocWithAuditReason", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "GetEdocWithAuditReason" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/GetEdocWithAuditReason", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "GetEdocWithAuditReason" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry is locked.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/GetEdocWithAuditReason", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "GetEdocWithAuditReason" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "POST", "header": [ { "description": "An optional header used to retrieve partial content of the edoc. Only supports single range with byte unit.", "key": "Range", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/Laserfiche.Repository.Document/GetEdocWithAuditReason", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "Laserfiche.Repository.Document", "GetEdocWithAuditReason" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] } ] }, { "name": "template", "item": [ { "name": "Removes the currently assigned template from an entry.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The ID of the entry that will have its template removed." } ] }, "description": "- Remove the currently assigned template from the specified entry.\n- Provide an entry ID to clear template value on.\n- If the entry does not have a template assigned, no change will be made.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Remove the currently assigned template successfully.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"fullPath\": \"\",\n \"folderPath\": \"\",\n \"creator\": \"\",\n \"creationTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"entryType\": \"Shortcut\",\n \"isContainer\": \"\",\n \"isLeaf\": \"\",\n \"templateName\": \"\",\n \"templateId\": \"\",\n \"templateFieldNames\": [\n \"\",\n \"\"\n ],\n \"volumeName\": \"\",\n \"rowNumber\": \"\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"veniam3\": {},\n \"dolorc\": {},\n \"ad6cd\": {},\n \"dolorea\": {}\n },\n {\n \"enim95d\": {}\n }\n ],\n \"fieldType\": \"DateTime\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"quis8\": {}\n },\n {\n \"esse_e\": {}\n }\n ],\n \"fieldType\": \"Time\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n }\n ]\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry is locked.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] }, { "name": "Assigns a template to an entry.", "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"templateName\": \"\",\n \"fields\": {\n \"magna_4\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"veniame\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nostrud5e\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"dolor147\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"adipisicing_f42\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The ID of entry that will have its template updated." } ] }, "description": "- Assign a template to an entry.\n- Provide an entry ID, template name, and a list of template fields to assign to that entry.\n- Only template values will be modified. Any existing independent fields on the entry will not be modified, nor will they be added if included in the request. The only modification to fields will only occur on templated fields. If the previously assigned template includes common template fields as the newly assigned template, the common field values will not be modified.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Assign a template successfully.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateName\": \"\",\n \"fields\": {\n \"magna_4\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"veniame\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nostrud5e\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"dolor147\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"adipisicing_f42\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"fullPath\": \"\",\n \"folderPath\": \"\",\n \"creator\": \"\",\n \"creationTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"entryType\": \"Shortcut\",\n \"isContainer\": \"\",\n \"isLeaf\": \"\",\n \"templateName\": \"\",\n \"templateId\": \"\",\n \"templateFieldNames\": [\n \"\",\n \"\"\n ],\n \"volumeName\": \"\",\n \"rowNumber\": \"\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"veniam3\": {},\n \"dolorc\": {},\n \"ad6cd\": {},\n \"dolorea\": {}\n },\n {\n \"enim95d\": {}\n }\n ],\n \"fieldType\": \"DateTime\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"quis8\": {}\n },\n {\n \"esse_e\": {}\n }\n ],\n \"fieldType\": \"Time\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n }\n ]\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateName\": \"\",\n \"fields\": {\n \"magna_4\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"veniame\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nostrud5e\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"dolor147\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"adipisicing_f42\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateName\": \"\",\n \"fields\": {\n \"magna_4\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"veniame\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nostrud5e\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"dolor147\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"adipisicing_f42\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateName\": \"\",\n \"fields\": {\n \"magna_4\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"veniame\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nostrud5e\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"dolor147\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"adipisicing_f42\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateName\": \"\",\n \"fields\": {\n \"magna_4\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"veniame\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nostrud5e\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"dolor147\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"adipisicing_f42\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateName\": \"\",\n \"fields\": {\n \"magna_4\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"veniame\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nostrud5e\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"dolor147\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"adipisicing_f42\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry is locked.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateName\": \"\",\n \"fields\": {\n \"magna_4\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"veniame\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nostrud5e\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"dolor147\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"adipisicing_f42\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"templateName\": \"\",\n \"fields\": {\n \"magna_4\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"veniame\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"nostrud5e\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"dolor147\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n },\n \"adipisicing_f42\": {\n \"values\": [\n {\n \"value\": \"\",\n \"position\": \"\"\n },\n {\n \"value\": \"\",\n \"position\": \"\"\n }\n ]\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId/template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId", "template" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag. This may be used when setting field values with tokens." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Returns a single entry object.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Returns a single entry object.\n- Provide an entry ID, and get the entry associated with that ID. Useful when detailed information about the entry is required, such as metadata, path information, etc.\n- If the entry is a subtype (Folder, Document, or Shortcut), the entry will automatically be converted to include those model-specific properties.\n- Allowed OData query options: Select.\n- When OData Select query option is used, 'entryType' is always included in the result.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get entry successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"fullPath\": \"\",\n \"folderPath\": \"\",\n \"creator\": \"\",\n \"creationTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"entryType\": \"Shortcut\",\n \"isContainer\": \"\",\n \"isLeaf\": \"\",\n \"templateName\": \"\",\n \"templateId\": \"\",\n \"templateFieldNames\": [\n \"\",\n \"\"\n ],\n \"volumeName\": \"\",\n \"rowNumber\": \"\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"veniam3\": {},\n \"dolorc\": {},\n \"ad6cd\": {},\n \"dolorea\": {}\n },\n {\n \"enim95d\": {}\n }\n ],\n \"fieldType\": \"DateTime\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"quis8\": {}\n },\n {\n \"esse_e\": {}\n }\n ],\n \"fieldType\": \"Time\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n }\n ]\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Requested entry id not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] }, { "name": "Deletes an entry asynchronously.", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Begins an asynchronous task to delete an entry, and returns an operationToken. Check the progress via the Tasks/{operationToken} route.\n- Provide an entry ID, and queue a delete task to remove it from the repository (includes nested objects if the entry is a Folder type). The entry will not be deleted immediately.\n- Optionally include an audit reason ID and comment in the JSON body.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Delete entry operation start successfully.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"token\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Operation limit or request limit reached.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"comment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] }, { "name": "Moves and/or renames an entry.", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Moves and/or renames an entry.\n- Move and/or rename an entry by passing in the new parent folder ID or name in the JSON body.\n- Optional parameter: autoRename (default false). If an entry already exists with the given name, the entry will be automatically renamed.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "Moves and/or renames an entry successfully.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"fullPath\": \"\",\n \"folderPath\": \"\",\n \"creator\": \"\",\n \"creationTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"entryType\": \"Shortcut\",\n \"isContainer\": \"\",\n \"isLeaf\": \"\",\n \"templateName\": \"\",\n \"templateId\": \"\",\n \"templateFieldNames\": [\n \"\",\n \"\"\n ],\n \"volumeName\": \"\",\n \"rowNumber\": \"\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"veniam3\": {},\n \"dolorc\": {},\n \"ad6cd\": {},\n \"dolorea\": {}\n },\n {\n \"enim95d\": {}\n }\n ],\n \"fieldType\": \"DateTime\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"quis8\": {}\n },\n {\n \"esse_e\": {}\n }\n ],\n \"fieldType\": \"Time\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n }\n ]\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request entry id not found.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry name conflicts.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Entry is locked.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Locked (WebDAV) (RFC 4918)", "code": 423, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/:entryId?autoRename=&culture=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", ":entryId" ], "query": [ { "key": "autoRename", "value": "", "description": "An optional query parameter used to indicate if the entry should be automatically renamed if another entry already exists with the same name in the folder. The default value is false." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used. The value should be a standard language tag." } ], "variable": [ { "key": "repoId" }, { "key": "entryId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "ByPath", "item": [ { "name": "Returns a single entry object using the entry path.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", "ByPath" ], "query": [ { "key": "fullPath", "value": "", "description": "(Required) The requested entry path." }, { "key": "fallbackToClosestAncestor", "value": "false", "description": "An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Returns a single entry object using the entry path.\n- Optional query parameter: fallbackToClosestAncestor. Use the fallbackToClosestAncestor query parameter to return the closest existing ancestor if the initial entry path is not found.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get entry successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", "ByPath" ], "query": [ { "key": "fullPath", "value": "", "description": "(Required) The requested entry path." }, { "key": "fallbackToClosestAncestor", "value": "false", "description": "An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false." } ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"entry\": {\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"fullPath\": \"\",\n \"folderPath\": \"\",\n \"creator\": \"\",\n \"creationTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"entryType\": \"RecordSeries\",\n \"isContainer\": \"\",\n \"isLeaf\": \"\",\n \"templateName\": \"\",\n \"templateId\": \"\",\n \"templateFieldNames\": [\n \"\",\n \"\"\n ],\n \"volumeName\": \"\",\n \"rowNumber\": \"\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"irure8\": {},\n \"sit8\": {}\n },\n {\n \"aliquad0e\": {}\n }\n ],\n \"fieldType\": \"Time\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"incididunt_3d\": {}\n },\n {\n \"reprehenderit6d3\": {}\n }\n ],\n \"fieldType\": \"Date\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n }\n ]\n },\n \"ancestorEntry\": {\n \"id\": \"\",\n \"name\": \"\",\n \"parentId\": \"\",\n \"fullPath\": \"\",\n \"folderPath\": \"\",\n \"creator\": \"\",\n \"creationTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"entryType\": \"RecordSeries\",\n \"isContainer\": \"\",\n \"isLeaf\": \"\",\n \"templateName\": \"\",\n \"templateId\": \"\",\n \"templateFieldNames\": [\n \"\",\n \"\"\n ],\n \"volumeName\": \"\",\n \"rowNumber\": \"\",\n \"fields\": [\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"id7\": {}\n },\n {\n \"Utb4a\": {},\n \"aliquipea3\": {}\n }\n ],\n \"fieldType\": \"Time\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n },\n {\n \"fieldName\": \"\",\n \"values\": [\n {\n \"aliqua_474\": {},\n \"dolore3b0\": {}\n },\n {\n \"magna7bc\": {}\n }\n ],\n \"fieldType\": \"String\",\n \"fieldId\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\"\n }\n ]\n }\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", "ByPath" ], "query": [ { "key": "fullPath", "value": "", "description": "(Required) The requested entry path." }, { "key": "fallbackToClosestAncestor", "value": "false", "description": "An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", "ByPath" ], "query": [ { "key": "fullPath", "value": "", "description": "(Required) The requested entry path." }, { "key": "fallbackToClosestAncestor", "value": "false", "description": "An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", "ByPath" ], "query": [ { "key": "fullPath", "value": "", "description": "(Required) The requested entry path." }, { "key": "fallbackToClosestAncestor", "value": "false", "description": "An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Requested entry path not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", "ByPath" ], "query": [ { "key": "fullPath", "value": "", "description": "(Required) The requested entry path." }, { "key": "fallbackToClosestAncestor", "value": "false", "description": "An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Entries", "ByPath" ], "query": [ { "key": "fullPath", "value": "", "description": "(Required) The requested entry path." }, { "key": "fallbackToClosestAncestor", "value": "false", "description": "An optional query parameter used to indicate whether or not the closest ancestor in the path should be returned if the initial entry path is not found. The default value is false." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] } ] }, { "name": "Attributes", "item": [ { "name": "{attributeKey}", "item": [ { "name": "Returns an attribute object associated with the authenticated user.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes/:attributeKey?everyone=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "attributeKey", "value": "", "description": "(Required) The requested attribute key." } ] }, "description": "- Returns the attribute associated with the key. Alternatively, return the attribute associated with the key within \"Everyone\" group.\n- Optional query parameters: everyone (bool, default false). When true, the server only searches for the attribute value with the given key upon the authenticated users attributes. If false, only the authenticated users attributes will be queried.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get trustee attribute value successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes/:attributeKey?everyone=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user." } ], "variable": [ { "key": "repoId" }, { "key": "attributeKey" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"key\": \"\",\n \"value\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes/:attributeKey?everyone=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user." } ], "variable": [ { "key": "repoId" }, { "key": "attributeKey" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes/:attributeKey?everyone=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user." } ], "variable": [ { "key": "repoId" }, { "key": "attributeKey" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes/:attributeKey?everyone=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user." } ], "variable": [ { "key": "repoId" }, { "key": "attributeKey" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Requested attribute key not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes/:attributeKey?everyone=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user." } ], "variable": [ { "key": "repoId" }, { "key": "attributeKey" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes/:attributeKey?everyone=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes associated with everyone or the currently authenticated user." } ], "variable": [ { "key": "repoId" }, { "key": "attributeKey" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Returns the attribute key value pairs associated with the authenticated user.", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes?everyone=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Returns the attribute key value pairs associated with the authenticated user. Alternatively, return only the attribute key value pairs that are associated with the \"Everyone\" group.\n- Attribute keys can be used with subsequent calls to get specific attribute values.\n- Optional query parameters: everyone (bool, default false). When true, this route does not return the attributes that are tied to the currently authenticated user, but rather the attributes assigned to the \"Everyone\" group. Note when this is true, the response does not include both the \"Everyone\" groups attribute and the currently authenticated user, but only the \"Everyone\" groups.\n- Default page size: 100. Allowed OData query options: Select, Count, OrderBy, Skip, Top, SkipToken, Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get trustee attribute key value pairs successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes?everyone=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes?everyone=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes?everyone=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes?everyone=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes?everyone=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Attributes?everyone=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Attributes" ], "query": [ { "key": "everyone", "value": "", "description": "Boolean value that indicates whether to return attributes key value pairs associated with everyone or the currently authenticated user." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "FieldDefinitions", "item": [ { "name": "{fieldDefinitionId}", "item": [ { "name": "Returns a single field definition object.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions/:fieldDefinitionId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions", ":fieldDefinitionId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "fieldDefinitionId", "value": "", "description": "(Required) The requested field definition ID." } ] }, "description": "- Returns a single field definition associated with the specified ID. \n- Useful when a route provides a minimal amount of details and more information about the specific field definition is needed.\n- Allowed OData query options: Select\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get field definition successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions/:fieldDefinitionId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions", ":fieldDefinitionId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "fieldDefinitionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"name\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"fieldType\": \"String\",\n \"length\": \"\",\n \"defaultValue\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"constraint\": \"\",\n \"constraintError\": \"\",\n \"listValues\": [\n \"\",\n \"\"\n ],\n \"format\": \"ShortTime\",\n \"currency\": \"\",\n \"formatPattern\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions/:fieldDefinitionId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions", ":fieldDefinitionId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "fieldDefinitionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions/:fieldDefinitionId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions", ":fieldDefinitionId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "fieldDefinitionId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions/:fieldDefinitionId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions", ":fieldDefinitionId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "fieldDefinitionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Requested field definition id not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions/:fieldDefinitionId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions", ":fieldDefinitionId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "fieldDefinitionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions/:fieldDefinitionId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions", ":fieldDefinitionId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "fieldDefinitionId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Returns the paged listing of the field definitions available in a repository.", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Returns a paged listing of field definitions available in the specified repository.\n- Useful when trying to find a list of all field definitions available, rather than only those assigned to a specific entry/template.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get field definitions successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "FieldDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "LinkDefinitions", "item": [ { "name": "{linkTypeId}", "item": [ { "name": "Returns a single link definition object.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions/:linkTypeId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions", ":linkTypeId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "linkTypeId", "value": "", "description": "(Required) The requested link type ID." } ] }, "description": "- Returns a single link definition associated with the specified ID.\n- Provide a link type ID and get the associated link definition. Useful when a route provides a minimal amount of details and more information about the specific link definition is needed.\n- Allowed OData query options: Select\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get link definition successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions/:linkTypeId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions", ":linkTypeId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "linkTypeId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"linkTypeId\": \"\",\n \"sourceLabel\": \"\",\n \"targetLabel\": \"\",\n \"linkTypeDescription\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions/:linkTypeId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions", ":linkTypeId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "linkTypeId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions/:linkTypeId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions", ":linkTypeId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "linkTypeId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions/:linkTypeId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions", ":linkTypeId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "linkTypeId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Requested link type definition ID not found", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions/:linkTypeId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions", ":linkTypeId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "linkTypeId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions/:linkTypeId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions", ":linkTypeId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "linkTypeId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Returns the link definitions associated with a repository.", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Returns the link definitions in the repository.\n- Provide a repository ID and get a paged listing of link definitions available in the repository. Useful when trying to display all link definitions available, not only links assigned to a specific entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get link definitions successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "LinkDefinitions" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "AuditReasons", "item": [ { "name": "Returns the audit reasons associated with the authenticated user.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/AuditReasons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "AuditReasons" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Returns the audit reasons associated with the authenticated user. Inherited audit reasons are included.\n- Only includes audit reasons associated with available API functionalities, like delete entry and export document.\n- If the authenticated user does not have the appropriate Laserfiche feature right, the audit reasons associated with that feature right will not be included.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get audit reasons successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/AuditReasons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "AuditReasons" ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"deleteEntry\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ],\n \"exportDocument\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\n }\n ]\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/AuditReasons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "AuditReasons" ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/AuditReasons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "AuditReasons" ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/AuditReasons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "AuditReasons" ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/AuditReasons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "AuditReasons" ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/AuditReasons", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "AuditReasons" ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Searches", "item": [ { "name": "{searchToken}", "item": [ { "name": "Results", "item": [ { "name": "{rowNumber}", "item": [ { "name": "ContextHits", "item": [ { "name": "Returns the context hits associated with a search result entry.", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results", ":rowNumber", "ContextHits" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "searchToken", "value": "", "description": "(Required) The requested searchToken." }, { "key": "rowNumber", "value": "", "description": "(Required) The search result listing row number to get context hits for." } ] }, "description": "- Returns the context hits associated with a search result entry.\n- Given a searchToken, and rowNumber associated with a search entry in the listing, return the context hits for that entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get search context hits successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results", ":rowNumber", "ContextHits" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" }, { "key": "rowNumber" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results", ":rowNumber", "ContextHits" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" }, { "key": "rowNumber" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results", ":rowNumber", "ContextHits" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" }, { "key": "rowNumber" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results", ":rowNumber", "ContextHits" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" }, { "key": "rowNumber" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request search token not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results", ":rowNumber", "ContextHits" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" }, { "key": "rowNumber" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results", ":rowNumber", "ContextHits" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" }, { "key": "rowNumber" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] } ] }, { "name": "Returns the results listing associated with a search operation.", "request": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results?groupByEntryType=&refresh=&fields=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "refresh", "value": "", "description": "If the search listing should be refreshed to show updated values." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "searchToken", "value": "", "description": "(Required) The requested searchToken." } ] }, "description": "- Returns a search result listing if the search is completed.\n- Search results expire after 5 minutes, but can be refreshed by retrieving the results again.\n- Optional query parameter: groupByOrderType (default false). This query parameter decides whether or not results are returned in groups based on their entry type.\n- Optional query parameter: refresh (default false). If the search listing should be refreshed to show updated values.\n- Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.\n- Default page size: 150. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer. OData $OrderBy syntax should follow: \"PropertyName direction,PropertyName2 direction\". sort order can be either \"asc\" or \"desc\".\n- When OData Select query option is used, 'entryType' is always included in the result.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get search result successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results?groupByEntryType=&refresh=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "refresh", "value": "", "description": "If the search listing should be refreshed to show updated values." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results?groupByEntryType=&refresh=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "refresh", "value": "", "description": "If the search listing should be refreshed to show updated values." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results?groupByEntryType=&refresh=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "refresh", "value": "", "description": "If the search listing should be refreshed to show updated values." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results?groupByEntryType=&refresh=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "refresh", "value": "", "description": "If the search listing should be refreshed to show updated values." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request search token not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results?groupByEntryType=&refresh=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "refresh", "value": "", "description": "If the search listing should be refreshed to show updated values." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional odata header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken/Results?groupByEntryType=&refresh=&fields=&formatFields=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken", "Results" ], "query": [ { "key": "groupByEntryType", "value": "", "description": "An optional query parameter used to indicate if the result should be grouped by entry type or not." }, { "key": "refresh", "value": "", "description": "If the search listing should be refreshed to show updated values." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Returns the status of a search operation.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "searchToken", "value": "", "description": "(Required) The requested searchToken." } ] }, "description": "- Returns search status.\n- Provide a token (returned in the create search asynchronous route), and get the search status, progress, and any errors that may have occurred. When the search is completed, the Location header can be inspected as a link to the search results.\n- OperationStatus can be one of the following : NotStarted, InProgress, Completed, Failed, or Canceled.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Search has failed. Check the errors property to find out why.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operationToken\": \"\",\n \"operationType\": \"\",\n \"percentComplete\": \"\",\n \"status\": \"Failed\",\n \"errors\": [\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"redirectUri\": \"\",\n \"entryId\": \"\",\n \"startTimestamp\": \"\",\n \"statusTimestamp\": \"\"\n}" }, { "name": "Search is completed.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operationToken\": \"\",\n \"operationType\": \"\",\n \"percentComplete\": \"\",\n \"status\": \"Failed\",\n \"errors\": [\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"redirectUri\": \"\",\n \"entryId\": \"\",\n \"startTimestamp\": \"\",\n \"statusTimestamp\": \"\"\n}" }, { "name": "Search is still in progress or not started.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operationToken\": \"\",\n \"operationType\": \"\",\n \"percentComplete\": \"\",\n \"status\": \"Failed\",\n \"errors\": [\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"redirectUri\": \"\",\n \"entryId\": \"\",\n \"startTimestamp\": \"\",\n \"statusTimestamp\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request search token not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] }, { "name": "Cancels or closes a search operation.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "searchToken", "value": "", "description": "(Required) The requested searchToken." } ] }, "description": "- Cancels a currently running search.\n- Closes a completed search.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Cancel or closed search successfully.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request search token not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches/:searchToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches", ":searchToken" ], "variable": [ { "key": "repoId" }, { "key": "searchToken" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Runs a search in the specified repository.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\",\n \"fuzzyType\": \"Percentage\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Runs a search operation on the repository.\n- The status for search operations must be checked via the Search specific status checking route.\n- For datetime search criteria that relate to time zone like CreateDate and ModifiedDate, the value should be in UTC time.\n- Optional body parameters: FuzzyType: (default none), which can be used to determine what is considered a match by number of letters or percentage. FuzzyFactor: integer value that determines the degree to which a search will be considered a match (integer value for NumberOfLetters, or int value representing a percentage).\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Search operation start successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\",\n \"fuzzyType\": \"Percentage\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches" ], "variable": [ { "key": "repoId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"token\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\",\n \"fuzzyType\": \"Percentage\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches" ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\",\n \"fuzzyType\": \"Percentage\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches" ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\",\n \"fuzzyType\": \"Percentage\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches" ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\",\n \"fuzzyType\": \"Percentage\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches" ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\",\n \"fuzzyType\": \"Percentage\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches" ], "variable": [ { "key": "repoId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Operation limit or request limit reached.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\",\n \"fuzzyType\": \"Percentage\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Searches", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Searches" ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "SimpleSearches", "item": [ { "name": "Runs a \"simple\" search operation.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/SimpleSearches?fields=&fields=&formatFields=&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "SimpleSearches" ], "query": [ { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Runs a \"simple\" search operation on the repository.\n- Returns a truncated search result listing.\n- Search result listing may be truncated, depending on number of results. Additionally, searches may time out if they take too long. Use the other search route to run full searches.\n- For datetime search criteria that relate to time zone like CreateDate and ModifiedDate, the value should be in UTC time.\n- Optionally returns field values for the entries in the folder. Each field name needs to be specified in the request. Maximum limit of 10 field names. If field values are requested, only the first value is returned if it is a multi value field. The remaining field values can be retrieved via the GET fields route. Null or Empty field values should not be used to determine if a field is assigned to the entry.\n- When OData Select query option is used, 'entryType' is always included in the result.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Simple search run successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/SimpleSearches?fields=&formatFields=&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "SimpleSearches" ], "query": [ { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "No search results found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/SimpleSearches?fields=&formatFields=&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "SimpleSearches" ], "query": [ { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "There are more search results.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/SimpleSearches?fields=&formatFields=&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "SimpleSearches" ], "query": [ { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Partial Content", "code": 206, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/SimpleSearches?fields=&formatFields=&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "SimpleSearches" ], "query": [ { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/SimpleSearches?fields=&formatFields=&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "SimpleSearches" ], "query": [ { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/SimpleSearches?fields=&formatFields=&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "SimpleSearches" ], "query": [ { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/SimpleSearches?fields=&formatFields=&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "SimpleSearches" ], "query": [ { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request is too large.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/SimpleSearches?fields=&formatFields=&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "SimpleSearches" ], "query": [ { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Request Entity Too Large", "code": 413, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Operation limit or request limit reached.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/SimpleSearches?fields=&formatFields=&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "SimpleSearches" ], "query": [ { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each search result. " }, { "key": "formatFields", "value": "", "description": "Boolean for if field values should be formatted. Only applicable if Fields are specified." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag. The formatFields query parameter must be set to true, otherwise culture will not be used for formatting." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "TagDefinitions", "item": [ { "name": "{tagId}", "item": [ { "name": "Returns a single tag definition object.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions", ":tagId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "tagId", "value": "", "description": "(Required) The requested tag definition ID." } ] }, "description": "- Returns a single tag definition.\n- Provide a tag definition ID, and get the single tag definition associated with that ID. Useful when another route provides a minimal amount of details, and more information about the specific tag is needed.\n- Allowed OData query options: Select\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get tag definition successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions", ":tagId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "tagId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"isSecure\": \"\",\n \"watermark\": {\n \"watermarkText\": \"\",\n \"watermarkTextSize\": \"\",\n \"watermarkPosition\": \"TopRight\",\n \"watermarkRotationAngle\": \"\",\n \"isWatermarkMandatory\": \"\",\n \"watermarkIntensity\": \"\"\n }\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions", ":tagId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "tagId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions", ":tagId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "tagId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions", ":tagId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "tagId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request tag definition id not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions", ":tagId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "tagId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions", ":tagId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "tagId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Returns the tag definitions associated with a repository.", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Returns all tag definitions in the repository.\n- Provide a repository ID and get a paged listing of tag definitions available in the repository. Useful when trying to display all tag definitions available, not only tags assigned to a specific entry.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get tag definitions successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TagDefinitions" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Tasks", "item": [ { "name": "{operationToken}", "item": [ { "name": "Returns the status of an operation.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID" }, { "key": "operationToken", "value": "", "description": "(Required) The operation token" } ] }, "description": "- Returns the status of an operation.\n- Provide an operationToken (returned in other asynchronous routes) to get the operation status, progress, and any errors that may have occurred. When the operation is completed, the Location header can be inspected as a link to the modified resources (if relevant).\n- OperationStatus can be one of the following values: NotStarted, InProgress, Completed, or Failed.\n- Required OAuth scope: None" }, "response": [ { "name": "Get completed or failed operation status with no result successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operationToken\": \"\",\n \"operationType\": \"\",\n \"percentComplete\": \"\",\n \"status\": \"Failed\",\n \"errors\": [\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"redirectUri\": \"\",\n \"entryId\": \"\",\n \"startTimestamp\": \"\",\n \"statusTimestamp\": \"\"\n}" }, { "name": "Get completed operation status with operation result url in Location header.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operationToken\": \"\",\n \"operationType\": \"\",\n \"percentComplete\": \"\",\n \"status\": \"Failed\",\n \"errors\": [\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"redirectUri\": \"\",\n \"entryId\": \"\",\n \"startTimestamp\": \"\",\n \"statusTimestamp\": \"\"\n}" }, { "name": "Get not started or in progress operation status successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"operationToken\": \"\",\n \"operationType\": \"\",\n \"percentComplete\": \"\",\n \"status\": \"Failed\",\n \"errors\": [\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"objectId\": \"\",\n \"errorMessage\": \"\"\n }\n ],\n \"redirectUri\": \"\",\n \"entryId\": \"\",\n \"startTimestamp\": \"\",\n \"statusTimestamp\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request operationToken not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] }, { "name": "Cancels an operation.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID" }, { "key": "operationToken", "value": "", "description": "(Required) The operation token" } ] }, "description": "- Cancels an operation.\n- Provide an operationToken to cancel the operation, if possible. Should be used if an operation was created in error, or is no longer necessary.\n- Rollbacks must be done manually. For example, if a copy operation is started and is halfway complete when canceled, the client application is responsible for cleaning up the files that were successfully copied before the operation was canceled.\n- Required OAuth scope: None" }, "response": [ { "name": "Cancel operation successfully.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "body": "" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request operationToken not found.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/Tasks/:operationToken", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "Tasks", ":operationToken" ], "variable": [ { "key": "repoId" }, { "key": "operationToken" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] } ] }, { "name": "TemplateDefinitions", "item": [ { "name": "{templateId}", "item": [ { "name": "Fields", "item": [ { "name": "Returns the field definitions assigned to a template definition (by template definition ID).", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId/Fields?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId", "Fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "templateId", "value": "", "description": "(Required) The requested template definition ID." } ] }, "description": "- Returns the field definitions assigned to a template definition.\n- Provide a template definition ID, and get a paged listing of the field definitions assigned to that template. \n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get template field definitions successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId/Fields?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId", "Fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId/Fields?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId", "Fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId/Fields?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId", "Fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId/Fields?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId", "Fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request template id not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId/Fields?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId", "Fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId/Fields?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId", "Fields" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Returns a single template definition object.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "templateId", "value": "", "description": "(Required) The requested template definition ID." } ] }, "description": "- Returns a single template definition (including field definitions, if relevant).\n- Provide a template definition ID, and get the single template definition associated with that ID. Useful when a route provides a minimal amount of details, and more information about the specific template is needed.\n- Allowed OData query options: Select\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get template definition successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"color\": {\n \"a\": \"\",\n \"r\": \"\",\n \"g\": \"\",\n \"b\": \"\"\n },\n \"fieldCount\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request template id not found.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", ":templateId" ], "query": [ { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repoId" }, { "key": "templateId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Fields", "item": [ { "name": "Returns the field definitions assigned to a template definition (by template definition name).", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/Fields?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", "Fields" ], "query": [ { "key": "templateName", "value": "", "description": "(Required) A required query parameter for the requested template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Returns the field definitions assigned to a template definition.\n- Provide a template definition name, and get a paged listing of the field definitions assigned to that template. \n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get template field definitions successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/Fields?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", "Fields" ], "query": [ { "key": "templateName", "value": "", "description": "(Required) A required query parameter for the requested template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/Fields?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", "Fields" ], "query": [ { "key": "templateName", "value": "", "description": "(Required) A required query parameter for the requested template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/Fields?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", "Fields" ], "query": [ { "key": "templateName", "value": "", "description": "(Required) A required query parameter for the requested template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/Fields?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", "Fields" ], "query": [ { "key": "templateName", "value": "", "description": "(Required) A required query parameter for the requested template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request template name not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/Fields?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", "Fields" ], "query": [ { "key": "templateName", "value": "", "description": "(Required) A required query parameter for the requested template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions/Fields?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions", "Fields" ], "query": [ { "key": "templateName", "value": "", "description": "(Required) A required query parameter for the requested template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Returns the template definitions associated with a repository.", "request": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions" ], "query": [ { "key": "templateName", "value": "", "description": "An optional query parameter. Can be used to get a single template definition using the template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Returns all template definitions (including field definitions) in the repository. If a template name query parameter is given, then a single template definition is returned.\n- Provide a repository ID, and get a paged listing of template definitions available in the repository. Useful when trying to find a list of all template definitions available, rather than a specific one.\n- Default page size: 100. Allowed OData query options: Select | Count | OrderBy | Skip | Top | SkipToken | Prefer.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get template definitions successfully.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions" ], "query": [ { "key": "templateName", "value": "", "description": "An optional query parameter. Can be used to get a single template definition using the template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions" ], "query": [ { "key": "templateName", "value": "", "description": "An optional query parameter. Can be used to get a single template definition using the template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions" ], "query": [ { "key": "templateName", "value": "", "description": "An optional query parameter. Can be used to get a single template definition using the template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions" ], "query": [ { "key": "templateName", "value": "", "description": "An optional query parameter. Can be used to get a single template definition using the template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Request template name not found.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions" ], "query": [ { "key": "templateName", "value": "", "description": "An optional query parameter. Can be used to get a single template definition using the template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "key": "Prefer", "value": "" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "TemplateDefinitions" ], "query": [ { "key": "templateName", "value": "", "description": "An optional query parameter. Can be used to get a single template definition using the template name." }, { "key": "culture", "value": "", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag." }, { "key": "$select", "value": "", "description": "Limits the properties returned in the result." }, { "key": "$orderby", "value": "", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5." }, { "key": "$top", "value": "", "description": "Limits the number of items returned from a collection." }, { "key": "$skip", "value": "", "description": "Excludes the specified number of items of the queried collection from the result." }, { "key": "$count", "value": "", "description": "Indicates whether the total count of items within a collection are returned in the result." } ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "ServerSession", "item": [ { "name": "Invalidate", "item": [ { "name": "Deprecated. Do not call this api.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Invalidate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Invalidate" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Deprecated.\n- Invalidates the server session.\n- Acts as a \"logout\" operation, and invalidates the session associated with the provided access token. This method should be used when the client wants to clean up the current session.\n- Only available in Laserfiche Cloud." }, "response": [ { "name": "Invalidate the server session successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Invalidate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Invalidate" ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Invalidate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Invalidate" ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Invalidate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Invalidate" ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Invalidate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Invalidate" ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Invalidate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Invalidate" ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Invalidate", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Invalidate" ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Refresh", "item": [ { "name": "Deprecated. Do not call this api.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Refresh" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Deprecated.\n- Refreshes the session associated with the access token. This is only necessary if you want to keep the same session alive, otherwise a new session will be automatically created when the session expires.\n- When a client application wants to keep a session alive that has been idle for an hour, this route can be used to refresh the expiration timer associated with the access token.\n- Only available in Laserfiche Cloud." }, "response": [ { "name": "Refresh the session successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Refresh" ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Refresh" ], "variable": [ { "key": "repoId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Refresh" ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Refresh" ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Refresh" ], "variable": [ { "key": "repoId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Refresh", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Refresh" ], "variable": [ { "key": "repoId" } ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] }, { "name": "Create", "item": [ { "name": "Deprecated. Do not call this api.", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Create", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Create" ], "variable": [ { "key": "repoId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Deprecated. This function is a no-op, always returns 200.\n- Only available in Laserfiche Cloud." }, "response": [ { "name": "Create the session successfully.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Create", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Create" ], "variable": [ { "key": "repoId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Create", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Create" ], "variable": [ { "key": "repoId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories/:repoId/ServerSession/Create", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories", ":repoId", "ServerSession", "Create" ], "variable": [ { "key": "repoId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] } ] } ] }, { "name": "Returns the list of repositories accessible to the user.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v1/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories" ] }, "description": "- Returns the repository resource list that current user has access to.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "Get the respository resource list successfully.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "[\n {\n \"repoId\": \"\",\n \"repoName\": \"\",\n \"webclientUrl\": \"\"\n },\n {\n \"repoId\": \"\",\n \"repoName\": \"\",\n \"webclientUrl\": \"\"\n }\n]" }, { "name": "Invalid or bad request.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories" ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access token is invalid or expired.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories" ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Access denied for the operation.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories" ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" }, { "name": "Rate limit is reached.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: bearer", "key": "Authorization", "value": "Bearer " } ], "url": { "raw": "{{baseUrl}}/v1/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v1", "Repositories" ] } }, "status": "Too Many Requests", "code": 429, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\"\n}" } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.laserfiche.com/repository" } ] }