{ "info": { "_postman_id": "4c8bb88b-0273-49be-a131-4e8daba34ab0", "name": "Laserfiche Repository API", "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/v2/changelog

Build# : 69c7f337a8ae3b90af88dc1080328c042d5a13df_.20240411.1

", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "35177085" }, "item": [ { "name": "v2", "item": [ { "name": "Repositories", "item": [ { "name": "{repositoryId}", "item": [ { "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}}/v2/Repositories/:repositoryId/Attributes/:attributeKey?everyone=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." } ], "variable": [ { "key": "repositoryId", "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": "A single attribute associated with the authenticated user.", "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}}/v2/Repositories/:repositoryId/Attributes/:attributeKey?everyone=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." } ], "variable": [ { "key": "repositoryId" }, { "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}}/v2/Repositories/:repositoryId/Attributes/:attributeKey?everyone=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Attributes/:attributeKey?everyone=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Attributes/:attributeKey?everyone=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Attributes/:attributeKey?everyone=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Attributes/:attributeKey?everyone=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes", ":attributeKey" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Attributes?everyone=false&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." }, { "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": "repositoryId", "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": "A collection of attributes associated with the authenticated user.", "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}}/v2/Repositories/:repositoryId/Attributes?everyone=false&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." }, { "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": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"key\": \"\",\n \"value\": \"\"\n },\n {\n \"key\": \"\",\n \"value\": \"\"\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/Attributes?everyone=false&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." }, { "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Attributes?everyone=false&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." }, { "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Attributes?everyone=false&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." }, { "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Attributes?everyone=false&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." }, { "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Attributes?everyone=false&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Attributes" ], "query": [ { "key": "everyone", "value": "false", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false." }, { "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "AuditReasons", "item": [ { "name": "Returns the audit reasons 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}}/v2/Repositories/:repositoryId/AuditReasons?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "AuditReasons" ], "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": "repositoryId", "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": "A collection of audit reasons.", "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}}/v2/Repositories/:repositoryId/AuditReasons?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "AuditReasons" ], "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": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"auditEventType\": \"DeleteEntry\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"auditEventType\": \"DeleteEntry\"\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/AuditReasons?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "AuditReasons" ], "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/AuditReasons?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "AuditReasons" ], "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/AuditReasons?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "AuditReasons" ], "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/AuditReasons?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "AuditReasons" ], "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/AuditReasons?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "AuditReasons" ], "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "FieldDefinitions", "item": [ { "name": "{fieldId}", "item": [ { "name": "Returns a single field definition object.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/FieldDefinitions/:fieldId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "FieldDefinitions", ":fieldId" ], "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": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "fieldId", "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": "A single field definition.", "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}}/v2/Repositories/:repositoryId/FieldDefinitions/:fieldId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "FieldDefinitions", ":fieldId" ], "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": "repositoryId" }, { "key": "fieldId" } ] } }, "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\": \"DateTime\",\n \"length\": \"\",\n \"defaultValue\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"constraint\": \"\",\n \"constraintError\": \"\",\n \"listValues\": [\n \"\",\n \"\"\n ],\n \"format\": \"Currency\",\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}}/v2/Repositories/:repositoryId/FieldDefinitions/:fieldId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "FieldDefinitions", ":fieldId" ], "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": "repositoryId" }, { "key": "fieldId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/FieldDefinitions/:fieldId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "FieldDefinitions", ":fieldId" ], "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": "repositoryId" }, { "key": "fieldId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/FieldDefinitions/:fieldId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "FieldDefinitions", ":fieldId" ], "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": "repositoryId" }, { "key": "fieldId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/FieldDefinitions/:fieldId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "FieldDefinitions", ":fieldId" ], "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": "repositoryId" }, { "key": "fieldId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/FieldDefinitions/:fieldId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "FieldDefinitions", ":fieldId" ], "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": "repositoryId" }, { "key": "fieldId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "A collection of field definitions.", "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}}/v2/Repositories/:repositoryId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"fieldType\": \"Date\",\n \"length\": \"\",\n \"defaultValue\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"constraint\": \"\",\n \"constraintError\": \"\",\n \"listValues\": [\n \"\",\n \"\"\n ],\n \"format\": \"ShortDate\",\n \"currency\": \"\",\n \"formatPattern\": \"\"\n },\n {\n \"name\": \"\",\n \"displayName\": \"\",\n \"id\": \"\",\n \"description\": \"\",\n \"fieldType\": \"Blob\",\n \"length\": \"\",\n \"defaultValue\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"constraint\": \"\",\n \"constraintError\": \"\",\n \"listValues\": [\n \"\",\n \"\"\n ],\n \"format\": \"ShortDate\",\n \"currency\": \"\",\n \"formatPattern\": \"\"\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "LinkDefinitions", "item": [ { "name": "{linkDefinitionId}", "item": [ { "name": "Returns a single link definition object.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/LinkDefinitions/:linkDefinitionId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "LinkDefinitions", ":linkDefinitionId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "linkDefinitionId", "value": "", "description": "(Required) The requested link definition ID." } ] }, "description": "- Returns a single link definition associated with the specified ID.\n- Provide a link definition 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": "A single link definition.", "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}}/v2/Repositories/:repositoryId/LinkDefinitions/:linkDefinitionId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "LinkDefinitions", ":linkDefinitionId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "key": "linkDefinitionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"id\": \"\",\n \"sourceLabel\": \"\",\n \"targetLabel\": \"\",\n \"description\": \"\"\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}}/v2/Repositories/:repositoryId/LinkDefinitions/:linkDefinitionId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "LinkDefinitions", ":linkDefinitionId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "key": "linkDefinitionId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/LinkDefinitions/:linkDefinitionId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "LinkDefinitions", ":linkDefinitionId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "key": "linkDefinitionId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/LinkDefinitions/:linkDefinitionId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "LinkDefinitions", ":linkDefinitionId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "key": "linkDefinitionId" } ] } }, "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 \"instanceDetail\": \"\"\n}" }, { "name": "Requested link 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}}/v2/Repositories/:repositoryId/LinkDefinitions/:linkDefinitionId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "LinkDefinitions", ":linkDefinitionId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "key": "linkDefinitionId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/LinkDefinitions/:linkDefinitionId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "LinkDefinitions", ":linkDefinitionId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "key": "linkDefinitionId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "A collection of link definitions.", "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}}/v2/Repositories/:repositoryId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"sourceLabel\": \"\",\n \"targetLabel\": \"\",\n \"description\": \"\"\n },\n {\n \"id\": \"\",\n \"sourceLabel\": \"\",\n \"targetLabel\": \"\",\n \"description\": \"\"\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/LinkDefinitions?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "Entries", "item": [ { "name": "CreateMultipartUploadUrls", "item": [ { "name": "Requests Upload URLs to upload a large file in chunks.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"numberOfParts\": \"\",\n \"uploadId\": \"\",\n \"startingPartNumber\": 1,\n \"fileName\": \"\",\n \"mimeType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/CreateMultipartUploadUrls", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", "CreateMultipartUploadUrls" ], "variable": [ { "key": "repositoryId", "value": "", "description": "(Required) The requested repository ID." } ] }, "description": "- Requests Upload URLs to upload a large file in chunks.\n- Returns an UploadId and an array of URLs to which the file chunks should be written in the same order.\n- To request a new batch of Upload URLs for the same file, set the value of UploadId to the one returned when the first batch of Upload URLs was requested. For requesting the first batch of Upload URLs, leave UploadId empty or null.\n- Example: if a file is going to be uploaded in 10 chunks, the 10 Upload URLs can be retrieved by two successive calls to this api, each call requesting 5 Upload URLs. For this, the first call should have StartingPartNumber=1 and NumberOfParts=5, and the second call should have StartingPartNumber=6 and NumberOfParts=5, along with UploadId returned in the first call.\n- Each Upload URL expires after 15 minutes.\n- Each file chunk written to an Upload URL should be at least 5 MB and at most 5 GB. There is no minimum size limit for the last chunk.\n- The value of NumberOfParts must be in the range [1, 100], meaning that in each call to this api, a maximum of 100 Upload URLs can be requested. \n- The total number of Upload URLs for a single file is 1000, which means (StartingPartNumber + NumberOfParts) should be less than or equal to 1001.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "A response containing an upload id and an array of upload URLs.", "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 \"numberOfParts\": \"\",\n \"uploadId\": \"\",\n \"startingPartNumber\": 1,\n \"fileName\": \"\",\n \"mimeType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/CreateMultipartUploadUrls", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", "CreateMultipartUploadUrls" ], "variable": [ { "key": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"uploadId\": \"\",\n \"urls\": [\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 \"numberOfParts\": \"\",\n \"uploadId\": \"\",\n \"startingPartNumber\": 1,\n \"fileName\": \"\",\n \"mimeType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/CreateMultipartUploadUrls", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", "CreateMultipartUploadUrls" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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 \"numberOfParts\": \"\",\n \"uploadId\": \"\",\n \"startingPartNumber\": 1,\n \"fileName\": \"\",\n \"mimeType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/CreateMultipartUploadUrls", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", "CreateMultipartUploadUrls" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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 \"numberOfParts\": \"\",\n \"uploadId\": \"\",\n \"startingPartNumber\": 1,\n \"fileName\": \"\",\n \"mimeType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/CreateMultipartUploadUrls", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", "CreateMultipartUploadUrls" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" }, { "name": "Requested repository 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 \"numberOfParts\": \"\",\n \"uploadId\": \"\",\n \"startingPartNumber\": 1,\n \"fileName\": \"\",\n \"mimeType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/CreateMultipartUploadUrls", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", "CreateMultipartUploadUrls" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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 \"numberOfParts\": \"\",\n \"uploadId\": \"\",\n \"startingPartNumber\": 1,\n \"fileName\": \"\",\n \"mimeType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/CreateMultipartUploadUrls", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", "CreateMultipartUploadUrls" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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 \"numberOfParts\": \"\",\n \"uploadId\": \"\",\n \"startingPartNumber\": 1,\n \"fileName\": \"\",\n \"mimeType\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/CreateMultipartUploadUrls", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", "CreateMultipartUploadUrls" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "{entryId}", "item": [ { "name": "Folder", "item": [ { "name": "ImportUploadedParts", "item": [ { "name": "Starts an asynchronous import task to import a document into a folder.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"uploadId\": \"\",\n \"partETags\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"autoRename\": false,\n \"pdfOptions\": {\n \"generateText\": false,\n \"generatePages\": false,\n \"generatePagesImageType\": \"HighQualityColor\",\n \"keepPdfAfterImport\": true\n },\n \"importAsElectronicDocument\": false,\n \"metadata\": {\n \"templateName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"in082\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"dolor_1a\": \"\",\n \"quis764\": \"\"\n }\n }\n ]\n },\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/ImportUploadedParts?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "ImportUploadedParts" ], "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": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The entry ID of the folder that the document will be created in." } ] }, "description": "- Imports a new file in the specified folder. The file should be already written (in chunks) to the upload URLs obtained by calling the Upload api. The maximum file size allowed is 64 GB.\n- This route does not support partial success.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "A long operation task id.", "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 \"uploadId\": \"\",\n \"partETags\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"autoRename\": false,\n \"pdfOptions\": {\n \"generateText\": false,\n \"generatePages\": false,\n \"generatePagesImageType\": \"HighQualityColor\",\n \"keepPdfAfterImport\": true\n },\n \"importAsElectronicDocument\": false,\n \"metadata\": {\n \"templateName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"in082\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"dolor_1a\": \"\",\n \"quis764\": \"\"\n }\n }\n ]\n },\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/ImportUploadedParts?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "ImportUploadedParts" ], "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": "repositoryId" }, { "key": "entryId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"taskId\": \"\"\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 \"uploadId\": \"\",\n \"partETags\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"autoRename\": false,\n \"pdfOptions\": {\n \"generateText\": false,\n \"generatePages\": false,\n \"generatePagesImageType\": \"HighQualityColor\",\n \"keepPdfAfterImport\": true\n },\n \"importAsElectronicDocument\": false,\n \"metadata\": {\n \"templateName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"in082\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"dolor_1a\": \"\",\n \"quis764\": \"\"\n }\n }\n ]\n },\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/ImportUploadedParts?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "ImportUploadedParts" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"uploadId\": \"\",\n \"partETags\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"autoRename\": false,\n \"pdfOptions\": {\n \"generateText\": false,\n \"generatePages\": false,\n \"generatePagesImageType\": \"HighQualityColor\",\n \"keepPdfAfterImport\": true\n },\n \"importAsElectronicDocument\": false,\n \"metadata\": {\n \"templateName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"in082\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"dolor_1a\": \"\",\n \"quis764\": \"\"\n }\n }\n ]\n },\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/ImportUploadedParts?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "ImportUploadedParts" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"uploadId\": \"\",\n \"partETags\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"autoRename\": false,\n \"pdfOptions\": {\n \"generateText\": false,\n \"generatePages\": false,\n \"generatePagesImageType\": \"HighQualityColor\",\n \"keepPdfAfterImport\": true\n },\n \"importAsElectronicDocument\": false,\n \"metadata\": {\n \"templateName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"in082\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"dolor_1a\": \"\",\n \"quis764\": \"\"\n }\n }\n ]\n },\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/ImportUploadedParts?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "ImportUploadedParts" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Requested repository 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 \"uploadId\": \"\",\n \"partETags\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"autoRename\": false,\n \"pdfOptions\": {\n \"generateText\": false,\n \"generatePages\": false,\n \"generatePagesImageType\": \"HighQualityColor\",\n \"keepPdfAfterImport\": true\n },\n \"importAsElectronicDocument\": false,\n \"metadata\": {\n \"templateName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"in082\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"dolor_1a\": \"\",\n \"quis764\": \"\"\n }\n }\n ]\n },\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/ImportUploadedParts?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "ImportUploadedParts" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"uploadId\": \"\",\n \"partETags\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"autoRename\": false,\n \"pdfOptions\": {\n \"generateText\": false,\n \"generatePages\": false,\n \"generatePagesImageType\": \"HighQualityColor\",\n \"keepPdfAfterImport\": true\n },\n \"importAsElectronicDocument\": false,\n \"metadata\": {\n \"templateName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"in082\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"dolor_1a\": \"\",\n \"quis764\": \"\"\n }\n }\n ]\n },\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/ImportUploadedParts?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "ImportUploadedParts" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"uploadId\": \"\",\n \"partETags\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"autoRename\": false,\n \"pdfOptions\": {\n \"generateText\": false,\n \"generatePages\": false,\n \"generatePagesImageType\": \"HighQualityColor\",\n \"keepPdfAfterImport\": true\n },\n \"importAsElectronicDocument\": false,\n \"metadata\": {\n \"templateName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"in082\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"dolor_1a\": \"\",\n \"quis764\": \"\"\n }\n }\n ]\n },\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/ImportUploadedParts?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "ImportUploadedParts" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Import operation failed due to an internal server error.", "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 \"uploadId\": \"\",\n \"partETags\": [\n \"\",\n \"\"\n ],\n \"name\": \"\",\n \"autoRename\": false,\n \"pdfOptions\": {\n \"generateText\": false,\n \"generatePages\": false,\n \"generatePagesImageType\": \"HighQualityColor\",\n \"keepPdfAfterImport\": true\n },\n \"importAsElectronicDocument\": false,\n \"metadata\": {\n \"templateName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ],\n \"tags\": [\n \"\",\n \"\"\n ],\n \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"in082\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"dolor_1a\": \"\",\n \"quis764\": \"\"\n }\n }\n ]\n },\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/ImportUploadedParts?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "ImportUploadedParts" ], "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": "repositoryId" }, { "key": "entryId" } ] } }, "status": "Internal Server Error", "code": 500, "_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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "CopyAsync", "item": [ { "name": "Starts an asynchronous copy task to copy an entry into a folder.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"sourceId\": \"\",\n \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/CopyAsync?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "CopyAsync" ], "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." } ], "variable": [ { "key": "repositoryId", "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 a taskId.\n- Provide the parent folder ID, and copy an entry as a child of the designated folder.\n- The status of the operation can be checked via the Tasks route.\n- Token substitution in the name of the copied entry is not supported.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "A long operation task id.", "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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/CopyAsync?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "CopyAsync" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "key": "entryId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"taskId\": \"\"\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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/CopyAsync?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "CopyAsync" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/CopyAsync?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "CopyAsync" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/CopyAsync?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "CopyAsync" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Requested repository 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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/CopyAsync?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "CopyAsync" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/CopyAsync?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "CopyAsync" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/CopyAsync?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "CopyAsync" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "Import", "item": [ { "name": "Imports a file into a folder (max length: 100 MB).", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "file", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "description": "(Required) Request body for importing an entry.", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Import?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Import" ], "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": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The entry ID of the folder that the document will be created in." } ] }, "description": "- Import a new document in the specified folder, and optionally assigns metadata.\n- The import may fail if the file is greater than 100 MB or time out if it takes longer than 60 seconds. These values are subject to change at anytime. Use the long operation asynchronous import if you run into these restrictions.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "The created entry.", "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": "file", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "description": "(Required) Request body for importing an entry.", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Import?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Import" ], "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": "repositoryId" }, { "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 \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Date\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\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": "file", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "description": "(Required) Request body for importing an entry.", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Import?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Import" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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": "file", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "description": "(Required) Request body for importing an entry.", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Import?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Import" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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": "file", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "description": "(Required) Request body for importing an entry.", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Import?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Import" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Request entry id 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": "file", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "description": "(Required) Request body for importing an entry.", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Import?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Import" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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": "file", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "description": "(Required) Request body for importing an entry.", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Import?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Import" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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": "file", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "description": "(Required) Request body for importing an entry.", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Import?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Import" ], "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Document creation is completely failed.", "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": "file", "value": "", "description": "(Required) ", "type": "text" }, { "key": "request", "value": "[object Object]", "description": "(Required) Request body for importing an entry.", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Import?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Import" ], "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": "repositoryId" }, { "key": "entryId" } ] } }, "status": "Internal Server Error", "code": 500, "_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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?groupByEntryType=false&fields=&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId", "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": "A collection of children entries of a folder.", "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?groupByEntryType=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry." }, { "key": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\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 \"name\": \"\",\n \"fieldType\": \"ShortInteger\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\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 \"name\": \"\",\n \"fieldType\": \"Time\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"List\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?groupByEntryType=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry." }, { "key": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?groupByEntryType=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry." }, { "key": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?groupByEntryType=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry." }, { "key": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?groupByEntryType=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry." }, { "key": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?groupByEntryType=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "fields", "value": "", "description": "Optional array of field names. Field values corresponding to the given field names will be returned for each entry." }, { "key": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] }, { "name": "Creates 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\": \"Shortcut\",\n \"autoRename\": false,\n \"targetId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "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." } ], "variable": [ { "key": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The folder ID that the entry will be created in." } ] }, "description": "- Create a new child entry in the designated folder.\n- Provide the parent folder ID, and based on the request body, create a folder/shortcut as a child entry of the designated folder.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "The created entry.", "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\": \"Shortcut\",\n \"autoRename\": false,\n \"targetId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Date\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\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 \"name\": \"\",\n \"entryType\": \"Shortcut\",\n \"autoRename\": false,\n \"targetId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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\": \"Shortcut\",\n \"autoRename\": false,\n \"targetId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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\": \"Shortcut\",\n \"autoRename\": false,\n \"targetId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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\": \"Shortcut\",\n \"autoRename\": false,\n \"targetId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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\": \"Shortcut\",\n \"autoRename\": false,\n \"targetId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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\": \"Shortcut\",\n \"autoRename\": false,\n \"targetId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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\": \"Shortcut\",\n \"autoRename\": false,\n \"targetId\": \"\",\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Children?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Children" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "Copy", "item": [ { "name": "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 \"sourceId\": \"\",\n \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Copy?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Copy" ], "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." } ], "variable": [ { "key": "repositoryId", "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.\n- Provide the parent folder ID, and based on the request body, copy a child entry of the designated folder.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "The copied entry.", "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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Copy?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Copy" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Date\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\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 \"name\": \"\",\n \"sourceId\": \"\",\n \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Copy?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Copy" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Copy?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Copy" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Copy?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Copy" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"sourceId\": \"\",\n \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Copy?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Copy" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"sourceId\": \"\",\n \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Copy?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Copy" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Copy?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Copy" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"sourceId\": \"\",\n \"autoRename\": false,\n \"volumeName\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Folder/Copy?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Folder", "Copy" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] } ] } ] }, { "name": "ExportAsync", "item": [ { "name": "Starts an asynchronous export task to export an entry.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/ExportAsync?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "ExportAsync" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc." } ], "variable": [ { "key": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The ID of entry to export." } ] }, "description": "- Starts an asynchronous export operation to export an entry.\n- If successful, it returns a taskId which can be used to check the status of the export operation or download the export result, otherwise, it returns an error.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "A long operation task id.", "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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/ExportAsync?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "ExportAsync" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc." } ], "variable": [ { "key": "repositoryId" }, { "key": "entryId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"taskId\": \"\"\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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/ExportAsync?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "ExportAsync" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/ExportAsync?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "ExportAsync" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/ExportAsync?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "ExportAsync" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Requested repository 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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/ExportAsync?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "ExportAsync" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/ExportAsync?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "ExportAsync" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/ExportAsync?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "ExportAsync" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Export operation failed due to an internal server error.", "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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/ExportAsync?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "ExportAsync" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when part=Edoc." } ], "variable": [ { "key": "repositoryId" }, { "key": "entryId" } ] } }, "status": "Internal Server Error", "code": 500, "_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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "Export", "item": [ { "name": "Exports an entry.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomLeft\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Export?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Export" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc." } ], "variable": [ { "key": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The ID of entry to export." } ] }, "description": "- Export an entry.\n- The export may time out if it takes longer than 60 seconds. This value is subject to change at anytime. Use the long operation asynchronous export if you run into this restriction.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "A link to download the exported entry.", "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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomLeft\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Export?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Export" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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": "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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomLeft\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Export?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Export" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomLeft\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Export?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Export" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomLeft\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Export?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Export" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomLeft\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Export?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Export" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomLeft\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Export?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Export" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Entry is locked.", "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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomLeft\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Export?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Export" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomLeft\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Export?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Export" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Export operation failed due to an internal server error.", "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 \"part\": \"Edoc\",\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\",\n \"imageOptions\": {\n \"format\": \"SinglePageTIFF\",\n \"jPEGCompressionLevel\": 70,\n \"includeAnnotations\": true,\n \"convertPdfAnnotations\": true,\n \"pagePrefix\": \", Page \",\n \"includeRedactions\": true,\n \"watermark\": {\n \"text\": \"\",\n \"position\": \"BottomLeft\",\n \"rotationAngle\": 0,\n \"pageSpanPercentage\": 50\n }\n },\n \"textOptions\": {\n \"includeRedactions\": true,\n \"redactionCharacter\": \"X\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Export?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Export" ], "query": [ { "key": "pageRange", "value": "", "description": "A comma-separated range of pages to include. Ex: 1,3,4 or 1-3,5-7,9. This value is ignored when exporting as Edoc." } ], "variable": [ { "key": "repositoryId" }, { "key": "entryId" } ] } }, "status": "Internal Server Error", "code": 500, "_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 \"instanceDetail\": \"\"\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 \"nisi_ef7\": \"\",\n \"sit6b\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repositoryId", "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": "A collection of dynamic field values.", "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 \"nisi_ef7\": \"\",\n \"sit6b\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repositoryId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"proident_a\": [\n \"\",\n \"\"\n ],\n \"anim5\": [\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 \"nisi_ef7\": \"\",\n \"sit6b\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"nisi_ef7\": \"\",\n \"sit6b\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"nisi_ef7\": \"\",\n \"sit6b\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"nisi_ef7\": \"\",\n \"sit6b\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"nisi_ef7\": \"\",\n \"sit6b\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"nisi_ef7\": \"\",\n \"sit6b\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields/GetDynamicFieldLogicValue", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields", "GetDynamicFieldLogicValue" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields" ], "query": [ { "key": "formatFieldValues", "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 formatFieldValues 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": "repositoryId", "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": "A collection of fields assigned to the entry.", "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields" ], "query": [ { "key": "formatFieldValues", "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 formatFieldValues 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": "repositoryId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"name\": \"\",\n \"fieldType\": \"String\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"ShortInteger\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields" ], "query": [ { "key": "formatFieldValues", "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 formatFieldValues 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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields" ], "query": [ { "key": "formatFieldValues", "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 formatFieldValues 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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields" ], "query": [ { "key": "formatFieldValues", "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 formatFieldValues 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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields" ], "query": [ { "key": "formatFieldValues", "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 formatFieldValues 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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Fields" ], "query": [ { "key": "formatFieldValues", "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 formatFieldValues 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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "A collection of fields assigned to the entry.", "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 \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"name\": \"\",\n \"fieldType\": \"String\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"ShortInteger\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\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 \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Fields?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "A collection of tags assigned to the entry.", "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"isSecure\": \"\",\n \"watermark\": {\n \"text\": \"\",\n \"pageSpanPercentage\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": \"\",\n \"isMandatory\": \"\",\n \"opacity\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"isSecure\": \"\",\n \"watermark\": {\n \"text\": \"\",\n \"pageSpanPercentage\": \"\",\n \"position\": \"TopCenter\",\n \"rotationAngle\": \"\",\n \"isMandatory\": \"\",\n \"opacity\": \"\"\n }\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Tags" ], "variable": [ { "key": "repositoryId", "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": "A collection of tags assigned to the entry.", "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Tags" ], "variable": [ { "key": "repositoryId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"isSecure\": \"\",\n \"watermark\": {\n \"text\": \"\",\n \"pageSpanPercentage\": \"\",\n \"position\": \"BottomCenter\",\n \"rotationAngle\": \"\",\n \"isMandatory\": \"\",\n \"opacity\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"isSecure\": \"\",\n \"watermark\": {\n \"text\": \"\",\n \"pageSpanPercentage\": \"\",\n \"position\": \"TopCenter\",\n \"rotationAngle\": \"\",\n \"isMandatory\": \"\",\n \"opacity\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Tags" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Tags" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Tags" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Tags" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Tags" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Tags" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Tags", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Tags" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"nisia1\": \"\",\n \"in_c9b\": \"\",\n \"magna_546\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"ex3ae\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Links", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Links" ], "variable": [ { "key": "repositoryId", "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": "A collection of links assigned to the entry.", "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 \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"nisia1\": \"\",\n \"in_c9b\": \"\",\n \"magna_546\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"ex3ae\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Links", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Links" ], "variable": [ { "key": "repositoryId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"sourceId\": \"\",\n \"sourceFullPath\": \"\",\n \"sourceLabel\": \"\",\n \"sourceLink\": \"\",\n \"targetId\": \"\",\n \"targetFullPath\": \"\",\n \"targetLabel\": \"\",\n \"targetLink\": \"\",\n \"linkDefinitionId\": \"\",\n \"linkDefinitionDescription\": \"\",\n \"customProperties\": {\n \"velit_f\": \"\",\n \"ea_a\": \"\",\n \"labore5\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"description\": \"\",\n \"sourceId\": \"\",\n \"sourceFullPath\": \"\",\n \"sourceLabel\": \"\",\n \"sourceLink\": \"\",\n \"targetId\": \"\",\n \"targetFullPath\": \"\",\n \"targetLabel\": \"\",\n \"targetLink\": \"\",\n \"linkDefinitionId\": \"\",\n \"linkDefinitionDescription\": \"\",\n \"customProperties\": {\n \"consecteturb5\": \"\",\n \"dolor1\": \"\",\n \"ade7\": \"\",\n \"Duisd\": \"\",\n \"ad_6\": \"\"\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 \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"nisia1\": \"\",\n \"in_c9b\": \"\",\n \"magna_546\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"ex3ae\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Links", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Links" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"nisia1\": \"\",\n \"in_c9b\": \"\",\n \"magna_546\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"ex3ae\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Links", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Links" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"nisia1\": \"\",\n \"in_c9b\": \"\",\n \"magna_546\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"ex3ae\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Links", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Links" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"nisia1\": \"\",\n \"in_c9b\": \"\",\n \"magna_546\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"ex3ae\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Links", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Links" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"nisia1\": \"\",\n \"in_c9b\": \"\",\n \"magna_546\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"ex3ae\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Links", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Links" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"nisia1\": \"\",\n \"in_c9b\": \"\",\n \"magna_546\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"ex3ae\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Links", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Links" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"links\": [\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"nisia1\": \"\",\n \"in_c9b\": \"\",\n \"magna_546\": \"\"\n }\n },\n {\n \"linkDefinitionId\": \"\",\n \"otherEntryId\": \"\",\n \"isSource\": true,\n \"customProperties\": {\n \"ex3ae\": \"\"\n }\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Links", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Links" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "A collection of links assigned to the entry.", "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "key": "entryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"description\": \"\",\n \"sourceId\": \"\",\n \"sourceFullPath\": \"\",\n \"sourceLabel\": \"\",\n \"sourceLink\": \"\",\n \"targetId\": \"\",\n \"targetFullPath\": \"\",\n \"targetLabel\": \"\",\n \"targetLink\": \"\",\n \"linkDefinitionId\": \"\",\n \"linkDefinitionDescription\": \"\",\n \"customProperties\": {\n \"velit_f\": \"\",\n \"ea_a\": \"\",\n \"labore5\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"description\": \"\",\n \"sourceId\": \"\",\n \"sourceFullPath\": \"\",\n \"sourceLabel\": \"\",\n \"sourceLink\": \"\",\n \"targetId\": \"\",\n \"targetFullPath\": \"\",\n \"targetLabel\": \"\",\n \"targetLink\": \"\",\n \"linkDefinitionId\": \"\",\n \"linkDefinitionDescription\": \"\",\n \"customProperties\": {\n \"consecteturb5\": \"\",\n \"dolor1\": \"\",\n \"ade7\": \"\",\n \"Duisd\": \"\",\n \"ad_6\": \"\"\n }\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Links?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Edoc", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Edoc" ], "variable": [ { "key": "repositoryId", "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": "The updated entry.", "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Edoc", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Edoc" ], "variable": [ { "key": "repositoryId" }, { "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 \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Date\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Edoc", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Edoc" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Edoc", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Edoc" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Edoc", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Edoc" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Edoc", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Edoc" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Edoc", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Edoc" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Edoc", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Edoc" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "Pages", "item": [ { "name": "Deletes the pages associated with an entry.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repositoryId", "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": "The updated entry.", "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repositoryId" }, { "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 \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Date\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Document/Pages?pageRange=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Document", "Pages" ], "query": [ { "key": "pageRange", "value": "", "description": "The pages to be deleted." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Template", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Template" ], "variable": [ { "key": "repositoryId", "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": "The updated entry.", "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}}/v2/Repositories/:repositoryId/Entries/:entryId/Template", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Template" ], "variable": [ { "key": "repositoryId" }, { "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 \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Date\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Template", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Template" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Template", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Template" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Template", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Template" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Template", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Template" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Template", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Template" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId/Template", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId", "Template" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "The updated entry.", "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 {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Date\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\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 \"templateName\": \"\",\n \"fields\": [\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId/Template?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "Starts an asynchronous delete task to delete an entry.", "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"auditReasonId\": \"\",\n \"auditReasonComment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "variable": [ { "key": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Begins a task to delete an entry, and returns a taskId.\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. This route returns a taskId, and will run as an asynchronous operation. Check the progress via the Tasks route.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "A long operation task id.", "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 \"auditReasonComment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "variable": [ { "key": "repositoryId" }, { "key": "entryId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"taskId\": \"\"\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 \"auditReasonComment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"auditReasonComment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"auditReasonComment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Requested repository 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 \"auditReasonComment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"auditReasonComment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"auditReasonComment\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] }, { "name": "Returns a single entry object.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId", "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": "A single entry.", "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}}/v2/Repositories/:repositoryId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "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 \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Date\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/:entryId?$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "query": [ { "key": "$select", "value": "", "description": "Limits the properties returned in the result." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] }, { "name": "Update an entry. (Move and/or Rename)", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parentId\": \"\",\n \"name\": \"\",\n \"autoRename\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "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." } ], "variable": [ { "key": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "entryId", "value": "", "description": "(Required) The requested entry ID." } ] }, "description": "- Update an entry. (Move and/or Rename)\n- Move an entry to a new folder by setting the ParentId in the request body.\n- Rename an entry by setting the Name in the request body.\n- Required OAuth scope: repository.Write" }, "response": [ { "name": "The updated entry.", "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 \"autoRename\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Date\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\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 \"autoRename\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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 \"autoRename\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Entries/:entryId?culture=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Entries", ":entryId" ], "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." } ], "variable": [ { "key": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "The found entry or ancestor entry.", "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}}/v2/Repositories/:repositoryId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"name\": \"\",\n \"fieldType\": \"List\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"DateTime\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\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 \"name\": \"\",\n \"fieldType\": \"LongInteger\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"List\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\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}}/v2/Repositories/:repositoryId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Entries/ByPath?fullPath=&fallbackToClosestAncestor=false", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] } ] } ] }, { "name": "Searches", "item": [ { "name": "SearchAsync", "item": [ { "name": "Starts an asynchronous search task.", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"searchCommand\": \"\",\n \"fuzzyType\": \"NumberOfLetters\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Searches/SearchAsync", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", "SearchAsync" ], "variable": [ { "key": "repositoryId", "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 Tasks 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": "A long operation task id.", "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\": \"NumberOfLetters\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Searches/SearchAsync", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", "SearchAsync" ], "variable": [ { "key": "repositoryId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"taskId\": \"\"\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\": \"NumberOfLetters\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Searches/SearchAsync", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", "SearchAsync" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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\": \"NumberOfLetters\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Searches/SearchAsync", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", "SearchAsync" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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\": \"NumberOfLetters\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Searches/SearchAsync", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", "SearchAsync" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" }, { "name": "Requested repository 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\": \"NumberOfLetters\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Searches/SearchAsync", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", "SearchAsync" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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\": \"NumberOfLetters\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Searches/SearchAsync", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", "SearchAsync" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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\": \"NumberOfLetters\",\n \"fuzzyFactor\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Searches/SearchAsync", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", "SearchAsync" ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "{taskId}", "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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "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": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "taskId", "value": "", "description": "(Required) The requested task ID." }, { "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 taskId, 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": "A collection of context hits for a search result.", "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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "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": "repositoryId" }, { "key": "taskId" }, { "key": "rowNumber" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"hitType\": \"VersionComment\",\n \"isAnnotationHit\": \"\",\n \"annotationId\": \"\",\n \"pageNumber\": \"\",\n \"pageOffset\": \"\",\n \"context\": \"\",\n \"highlight1Offset\": \"\",\n \"highlight1Length\": \"\",\n \"highlight2Offset\": \"\",\n \"highlight2Length\": \"\",\n \"hitWidth\": \"\",\n \"edocHitCount\": \"\",\n \"fieldHitCount\": \"\",\n \"fieldName\": \"\",\n \"hitNumber\": \"\"\n },\n {\n \"hitType\": \"Name\",\n \"isAnnotationHit\": \"\",\n \"annotationId\": \"\",\n \"pageNumber\": \"\",\n \"pageOffset\": \"\",\n \"context\": \"\",\n \"highlight1Offset\": \"\",\n \"highlight1Length\": \"\",\n \"highlight2Offset\": \"\",\n \"highlight2Length\": \"\",\n \"hitWidth\": \"\",\n \"edocHitCount\": \"\",\n \"fieldHitCount\": \"\",\n \"fieldName\": \"\",\n \"hitNumber\": \"\"\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "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": "repositoryId" }, { "key": "taskId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "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": "repositoryId" }, { "key": "taskId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "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": "repositoryId" }, { "key": "taskId" }, { "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 \"instanceDetail\": \"\"\n}" }, { "name": "Request taskId 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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "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": "repositoryId" }, { "key": "taskId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results/:rowNumber/ContextHits?$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "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": "repositoryId" }, { "key": "taskId" }, { "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 \"instanceDetail\": \"\"\n}" } ] } ] } ] }, { "name": "Returns the results listing associated with a search task.", "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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results?groupByEntryType=false&refresh=false&fields=&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "Results" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "refresh", "value": "false", "description": "Indicates if the search listing should be refreshed to show updated values. The default value is false." }, { "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId", "value": "", "description": "(Required) The requested repository ID." }, { "key": "taskId", "value": "", "description": "(Required) The requested task ID." } ] }, "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": "A collection of entry search results.", "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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results?groupByEntryType=false&refresh=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "Results" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "refresh", "value": "false", "description": "Indicates if the search listing should be refreshed to show updated values. The default value is false." }, { "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "key": "taskId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\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 \"name\": \"\",\n \"fieldType\": \"ShortInteger\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\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 \"name\": \"\",\n \"fieldType\": \"Time\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"List\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results?groupByEntryType=false&refresh=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "Results" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "refresh", "value": "false", "description": "Indicates if the search listing should be refreshed to show updated values. The default value is false." }, { "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "key": "taskId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results?groupByEntryType=false&refresh=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "Results" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "refresh", "value": "false", "description": "Indicates if the search listing should be refreshed to show updated values. The default value is false." }, { "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "key": "taskId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results?groupByEntryType=false&refresh=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "Results" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "refresh", "value": "false", "description": "Indicates if the search listing should be refreshed to show updated values. The default value is false." }, { "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "key": "taskId" } ] } }, "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 \"instanceDetail\": \"\"\n}" }, { "name": "Request taskId 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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results?groupByEntryType=false&refresh=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "Results" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "refresh", "value": "false", "description": "Indicates if the search listing should be refreshed to show updated values. The default value is false." }, { "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "key": "taskId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Searches/:taskId/Results?groupByEntryType=false&refresh=false&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Searches", ":taskId", "Results" ], "query": [ { "key": "groupByEntryType", "value": "false", "description": "Indicates if the result should be grouped by entry type or not. The default value is false." }, { "key": "refresh", "value": "false", "description": "Indicates if the search listing should be refreshed to show updated values. The default value is false." }, { "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" }, { "key": "taskId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/SimpleSearches?fields=&fields=&formatFieldValues=false&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId", "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": "A collection of entry 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}}/v2/Repositories/:repositoryId/SimpleSearches?fields=&formatFieldValues=false&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\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 \"name\": \"\",\n \"fieldType\": \"ShortInteger\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\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 \"name\": \"\",\n \"fieldType\": \"Time\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"List\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n }\n ]\n}" }, { "name": "A truncated collection of entry 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}}/v2/Repositories/:repositoryId/SimpleSearches?fields=&formatFieldValues=false&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" } ] } }, "status": "Partial Content", "code": 206, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\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 \"name\": \"\",\n \"fieldType\": \"ShortInteger\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"Blob\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\n ]\n },\n {\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 \"name\": \"\",\n \"fieldType\": \"Time\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n },\n {\n \"name\": \"\",\n \"fieldType\": \"List\",\n \"id\": \"\",\n \"isMultiValue\": \"\",\n \"isRequired\": \"\",\n \"hasMoreValues\": \"\",\n \"groupId\": \"\",\n \"values\": [\n \"\",\n \"\"\n ]\n }\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 \"searchCommand\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/SimpleSearches?fields=&formatFieldValues=false&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/SimpleSearches?fields=&formatFieldValues=false&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/SimpleSearches?fields=&formatFieldValues=false&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/SimpleSearches?fields=&formatFieldValues=false&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/SimpleSearches?fields=&formatFieldValues=false&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/SimpleSearches?fields=&formatFieldValues=false&culture=&$select=&$orderby=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "formatFieldValues", "value": "false", "description": "Indicates if field values should be formatted. Only applicable if Fields are specified. 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 formatFieldValues 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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "A single tag definition.", "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}}/v2/Repositories/:repositoryId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"text\": \"\",\n \"pageSpanPercentage\": \"\",\n \"position\": \"TopCenter\",\n \"rotationAngle\": \"\",\n \"isMandatory\": \"\",\n \"opacity\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions/:tagId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "A collection of tag definitions.", "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}}/v2/Repositories/:repositoryId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"isSecure\": \"\",\n \"watermark\": {\n \"text\": \"\",\n \"pageSpanPercentage\": \"\",\n \"position\": \"DeadCenter\",\n \"rotationAngle\": \"\",\n \"isMandatory\": \"\",\n \"opacity\": \"\"\n }\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"isSecure\": \"\",\n \"watermark\": {\n \"text\": \"\",\n \"pageSpanPercentage\": \"\",\n \"position\": \"DeadCenter\",\n \"rotationAngle\": \"\",\n \"isMandatory\": \"\",\n \"opacity\": \"\"\n }\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TagDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "Tasks", "item": [ { "name": "Returns the status of a set of one or more tasks.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Tasks?taskIds=&taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token." }, { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId", "value": "", "description": "(Required) The requested repository ID" } ] }, "description": "- Returns the status of a set of one or more tasks.\n- Provide a comma-separated list of task IDs to get the task status, progress, and any errors that may have occurred.\n- Leave the taskIds query parameter empty, to get the list of all the task IDs associated with the current access token.\n- TaskStatus can be one of the following values: NotStarted, InProgress, Completed, Cancelled, or Failed.\n- This API employs long polling technique and could return the result immediately (e.g. if the export operation is failed or completed successfully) or after at most 60 seconds.\n- Required OAuth scope: None" }, "response": [ { "name": "A collection of task progresses.", "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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": [\n {\n \"id\": \"\",\n \"taskType\": \"ImportUploadedParts\",\n \"percentComplete\": \"\",\n \"status\": \"Completed\",\n \"errors\": [\n {\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\",\n \"instanceDetail\": \"\"\n },\n {\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\",\n \"instanceDetail\": \"\"\n }\n ],\n \"result\": {\n \"entryId\": \"\",\n \"uri\": \"\"\n },\n \"startTime\": \"\",\n \"lastUpdateTime\": \"\"\n },\n {\n \"id\": \"\",\n \"taskType\": \"SearchEntry\",\n \"percentComplete\": \"\",\n \"status\": \"Failed\",\n \"errors\": [\n {\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\",\n \"instanceDetail\": \"\"\n },\n {\n \"status\": \"\",\n \"type\": \"\",\n \"title\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"operationId\": \"\",\n \"errorSource\": \"\",\n \"errorCode\": \"\",\n \"traceId\": \"\",\n \"instanceDetail\": \"\"\n }\n ],\n \"result\": {\n \"entryId\": \"\",\n \"uri\": \"\"\n },\n \"startTime\": \"\",\n \"lastUpdateTime\": \"\"\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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" }, { "name": "Repository is 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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to get the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] }, { "name": "Starts the cancellation for a set of one or more tasks.", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/Tasks?taskIds=&taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token." }, { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId", "value": "", "description": "(Required) The requested repository ID" } ] }, "description": "- Starts the cancellation for a set of one or more tasks.\n- Provide comma-separated list of task IDs to cancel. Should be used if an operation was created in error, or is no longer necessary.\n- Check the status of the task to determine if the task has been cancelled successfully.\n- Leave the taskIds query parameter empty, to cancel the list of all the task IDs associated with the current access token.\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": "A collection of task cancellation results.", "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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": [\n {\n \"id\": \"\",\n \"taskType\": \"SearchEntry\",\n \"result\": \"\"\n },\n {\n \"id\": \"\",\n \"taskType\": \"ExportEntry\",\n \"result\": \"\"\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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" }, { "name": "Repository is 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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/Tasks?taskIds=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "Tasks" ], "query": [ { "key": "taskIds", "value": "", "description": "An array of task IDs. Leave this parameter empty to cancel the list of all the tasks associated with the current access token." } ], "variable": [ { "key": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "TemplateDefinitions", "item": [ { "name": "{templateId}", "item": [ { "name": "FieldDefinitions", "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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", ":templateId", "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": "repositoryId", "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": "A collection of template field definitions.", "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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", ":templateId", "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": "repositoryId" }, { "key": "templateId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\"\n}" }, { "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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", ":templateId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", ":templateId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", ":templateId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", ":templateId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId/FieldDefinitions?culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", ":templateId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "Returns a single template definition object.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "A single template definition.", "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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/:templateId?culture=&$select=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" }, { "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 \"instanceDetail\": \"\"\n}" } ] } ] }, { "name": "FieldDefinitions", "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}}/v2/Repositories/:repositoryId/TemplateDefinitions/FieldDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", "FieldDefinitions" ], "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": "repositoryId", "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": "A collection of template field definitions.", "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}}/v2/Repositories/:repositoryId/TemplateDefinitions/FieldDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", "FieldDefinitions" ], "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": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\"\n}" }, { "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}}/v2/Repositories/:repositoryId/TemplateDefinitions/FieldDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", "FieldDefinitions" ], "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/FieldDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", "FieldDefinitions" ], "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/FieldDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", "FieldDefinitions" ], "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/FieldDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", "FieldDefinitions" ], "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions/FieldDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "TemplateDefinitions", "FieldDefinitions" ], "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId", "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": "A collection of template definitions.", "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}}/v2/Repositories/:repositoryId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"@odata.nextLink\": \"\",\n \"@odata.count\": \"\",\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"color\": {\n \"a\": \"\",\n \"r\": \"\",\n \"g\": \"\",\n \"b\": \"\"\n },\n \"fieldCount\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"displayName\": \"\",\n \"description\": \"\",\n \"color\": {\n \"a\": \"\",\n \"r\": \"\",\n \"g\": \"\",\n \"b\": \"\"\n },\n \"fieldCount\": \"\"\n }\n ]\n}" }, { "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}}/v2/Repositories/:repositoryId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\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}}/v2/Repositories/:repositoryId/TemplateDefinitions?templateName=&culture=&$select=&$orderby=&$top=&$skip=&$count=", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories", ":repositoryId", "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": "repositoryId" } ] } }, "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 \"instanceDetail\": \"\"\n}" } ] } ] } ] }, { "name": "Returns the list of repositories accessible to the user.", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/v2/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories" ] }, "description": "- Returns the repository resource list that current user has access to.\n- Required OAuth scope: repository.Read" }, "response": [ { "name": "A collection of respositories.", "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}}/v2/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "Repositories" ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "body": "{\n \"value\": [\n {\n \"id\": \"\",\n \"name\": \"\",\n \"webClientUrl\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\",\n \"webClientUrl\": \"\"\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}}/v2/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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 \"instanceDetail\": \"\"\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}}/v2/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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 \"instanceDetail\": \"\"\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}}/v2/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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 \"instanceDetail\": \"\"\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}}/v2/Repositories", "host": [ "{{baseUrl}}" ], "path": [ "v2", "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 \"instanceDetail\": \"\"\n}" } ] } ] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{bearerToken}}", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://api.laserfiche.com/repository" } ] }