Visit the changelog for the list of changes: /repository/v2/changelog
Build# : 1789668804_66f2190122a2e49b6b794b61131fe9c7d8a0520c
", "version": "2" }, "servers": [ { "url": "https://api.laserfiche.com/repository" } ], "paths": { "/v2/Repositories/{repositoryId}/Entries/{entryId}/Annotations": { "get": { "tags": [ "Annotations" ], "summary": "Returns all annotations on a document.", "description": "- Returns every annotation on every page of the document, as a polymorphic list keyed by annotation type.\n- Requires the \"see annotations\" entry right; redaction content is only revealed to callers with the \"see through redactions\" right.\n- Required OAuth scope: repository.Read", "operationId": "ListDocumentAnnotations", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "description": "The document entry ID.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "name": "$orderby", "in": "query", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", "schema": { "type": "string", "nullable": true }, "x-position": 5 }, { "name": "$count", "in": "query", "description": "Indicates whether the total count of items within a collection are returned in the result.", "schema": { "type": "boolean" }, "x-position": 6 } ], "responses": { "200": { "description": "Successfully returned the annotations on the document.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Annotation" } } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The requested document, page, or annotation was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/Entries/{entryId}/Pages/{pageNumber}/Annotations": { "get": { "tags": [ "Annotations" ], "summary": "Returns all annotations on a single page of a document.", "description": "- Returns the annotations on the requested page, as a polymorphic list keyed by annotation type.\n- Requires the \"see annotations\" entry right; redaction content is only revealed to callers with the \"see through redactions\" right.\n- Required OAuth scope: repository.Read", "operationId": "ListPageAnnotations", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "description": "The document entry ID.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "pageNumber", "in": "path", "required": true, "description": "The 1-based page number.", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 4 }, { "name": "$orderby", "in": "query", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", "schema": { "type": "string", "nullable": true }, "x-position": 6 }, { "name": "$count", "in": "query", "description": "Indicates whether the total count of items within a collection are returned in the result.", "schema": { "type": "boolean" }, "x-position": 7 } ], "responses": { "200": { "description": "Successfully returned the annotations on the page.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Annotation" } } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The requested document, page, or annotation was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Annotations" ], "summary": "Creates an annotation on a page.", "description": "- The request body is a polymorphic annotation discriminated by `annotationType`; supply the writable members for that type.\n- For attachment and bitmap annotations, create the annotation first, then upload its binary content via the dedicated sub-resource.\n- Requires the \"annotate\" entry right.\n- Required OAuth scope: repository.Write", "operationId": "CreateAnnotation", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "pageNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 3 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Annotation" } } }, "required": true, "x-position": 4 }, "responses": { "200": { "description": "Successfully created the annotation. Returned the created annotation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Annotation" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The requested document, page, or annotation was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/Entries/{entryId}/Pages/{pageNumber}/Annotations/{itemId}": { "get": { "tags": [ "Annotations" ], "summary": "Returns a single annotation by its item ID within a page.", "description": "- Returns the annotation, typed by annotation type.\n- Requires the \"see annotations\" entry right; redaction content is only revealed to callers with the \"see through redactions\" right.\n- Required OAuth scope: repository.Read", "operationId": "GetAnnotation", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "description": "The document entry ID.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "pageNumber", "in": "path", "required": true, "description": "The 1-based page number.", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "itemId", "in": "path", "required": true, "description": "The annotation item ID, unique within the page.", "schema": { "type": "integer", "format": "int32" }, "x-position": 4 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "Successfully returned the requested annotation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Annotation" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The requested document, page, or annotation was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Annotations" ], "summary": "Applies a partial update to an annotation.", "description": "- Supply only the members to change; omitted members are left unchanged. The `annotationType` must match the existing annotation.\n- Requires the \"annotate\" entry right.\n- Required OAuth scope: repository.Write", "operationId": "UpdateAnnotation", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "pageNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 4 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Annotation" } } }, "required": true, "x-position": 5 }, "responses": { "200": { "description": "Successfully updated the annotation. Returned the updated annotation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Annotation" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The requested document, page, or annotation was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Annotations" ], "summary": "Deletes an annotation.", "description": "- Requires the \"annotate\" entry right.\n- Required OAuth scope: repository.Write", "operationId": "DeleteAnnotation", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "pageNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 4 } ], "responses": { "204": { "description": "Successfully deleted the annotation." }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The requested document, page, or annotation was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/Entries/{entryId}/Pages/{pageNumber}/Annotations/{itemId}/Attachment": { "get": { "tags": [ "Annotations" ], "summary": "Returns the binary content of an attachment annotation.", "description": "- Streams the attached file. Fails with a bad request if the annotation is not an attachment.\n- Requires the \"see annotations\" entry right.\n- Required OAuth scope: repository.Read", "operationId": "GetAnnotationAttachment", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "description": "The document entry ID.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "pageNumber", "in": "path", "required": true, "description": "The 1-based page number.", "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "itemId", "in": "path", "required": true, "description": "The attachment annotation's item ID.", "schema": { "type": "integer", "format": "int32" }, "x-position": 4 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 5 } ], "responses": { "200": { "description": "Successfully returned the content of the attachment annotation.", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The requested document, page, or annotation was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Annotations" ], "summary": "Uploads the binary content of an attachment annotation.", "description": "- Send the file as multipart/form-data under the form field \"file\". The annotation must already exist and be an attachment annotation.\n- Requires the \"annotate\" entry right.\n- Required OAuth scope: repository.Write", "operationId": "UploadAnnotationAttachment", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "pageNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 4 } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "description": "The image file to upload. See https://doc.laserfiche.com/ for supported image file formats.", "format": "binary" } } } } } }, "responses": { "204": { "description": "Successfully uploaded the attachment content." }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The requested document, page, or annotation was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/AnnotationReasons": { "get": { "tags": [ "Annotations" ], "summary": "Returns the repository's annotation reasons.", "description": "- Returns the redaction reasons defined in the repository.\n- Required OAuth scope: repository.Read", "operationId": "ListAnnotationReasons", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "$orderby", "in": "query", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", "schema": { "type": "string", "nullable": true }, "x-position": 4 }, { "name": "$count", "in": "query", "description": "Indicates whether the total count of items within a collection are returned in the result.", "schema": { "type": "boolean" }, "x-position": 5 } ], "responses": { "200": { "description": "Successfully returned the repository's annotation reasons.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AnnotationReason" } } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Annotations" ], "summary": "Creates an annotation reason.", "description": "- Required OAuth scope: repository.Write", "operationId": "CreateAnnotationReason", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 1 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationReasonRequest" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Successfully created the annotation reason. Returned the created reason.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationReason" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/Entries/{entryId}/Pages/{pageNumber}/Annotations/{itemId}/Image": { "put": { "tags": [ "Annotations" ], "summary": "Uploads the image bytes of a bitmap annotation.", "description": "- Send the image as multipart/form-data under the form field \"file\". The annotation must already exist and be a bitmap annotation.\n- Requires the \"annotate\" entry right.\n- Required OAuth scope: repository.Write", "operationId": "UploadAnnotationImage", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "pageNumber", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 3 }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 4 } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "required": [ "file" ], "properties": { "file": { "type": "string", "description": "The image file to upload. See https://doc.laserfiche.com/ for supported image file formats.", "format": "binary" } } } } } }, "responses": { "204": { "description": "Successfully uploaded the bitmap annotation image." }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The requested document, page, or annotation was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/AnnotationReasons/{reasonId}": { "patch": { "tags": [ "Annotations" ], "summary": "Updates an annotation reason's text.", "description": "- Required OAuth scope: repository.Write", "operationId": "UpdateAnnotationReason", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 1 }, { "name": "reasonId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationReasonRequest" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "Successfully updated the annotation reason. Returned the updated reason.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnnotationReason" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Annotations" ], "summary": "Deletes an annotation reason.", "description": "- When `force` is false, deleting a reason that is in use fails.\n- Required OAuth scope: repository.Write", "operationId": "DeleteAnnotationReason", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 1 }, { "name": "reasonId", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "204": { "description": "Successfully deleted the annotation reason." }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/Attributes": { "get": { "tags": [ "Attributes" ], "summary": "Returns the attribute key value pairs associated with the authenticated user.", "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", "operationId": "ListAttributes", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "everyone", "in": "query", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false.", "schema": { "type": "boolean", "default": false }, "x-position": 2 }, { "name": "Prefer", "x-originalName": "prefer", "in": "header", "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 4 }, { "name": "$orderby", "in": "query", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", "schema": { "type": "string", "nullable": true }, "x-position": 5 }, { "name": "$top", "in": "query", "description": "Limits the number of items returned from a collection. The maximum value is 150.", "schema": { "type": "integer", "format": "int32" }, "x-position": 6 }, { "name": "$skip", "in": "query", "description": "Excludes the specified number of items of the queried collection from the result.", "schema": { "type": "integer", "format": "int32" }, "x-position": 7 }, { "name": "$count", "in": "query", "description": "Indicates whether the total count of items within a collection are returned in the result.", "schema": { "type": "boolean" }, "x-position": 8 } ], "responses": { "200": { "description": "Successfully returned the list of trustee attribute key value pairs for the authenticated user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeCollectionResponse" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/Attributes/{attributeKey}": { "get": { "tags": [ "Attributes" ], "summary": "Returns an attribute object associated with the authenticated user.", "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", "operationId": "GetAttribute", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "attributeKey", "in": "path", "required": true, "description": "The requested attribute key.", "schema": { "type": "string" }, "x-position": 2 }, { "name": "everyone", "in": "query", "description": "Indicates if attributes associated with the \"Everyone\" group or the currently authenticated user is returned. The default value is false.", "schema": { "type": "boolean", "default": false }, "x-position": 3 } ], "responses": { "200": { "description": "Successfully returned the specified attribute for the authenticated user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Attribute" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "The requested attribute key was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/AuditReasons": { "get": { "tags": [ "AuditReasons" ], "summary": "Returns the audit reasons associated with the authenticated user.", "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", "operationId": "ListAuditReasons", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "Prefer", "x-originalName": "prefer", "in": "header", "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "name": "$orderby", "in": "query", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", "schema": { "type": "string", "nullable": true }, "x-position": 4 }, { "name": "$top", "in": "query", "description": "Limits the number of items returned from a collection. The maximum value is 150.", "schema": { "type": "integer", "format": "int32" }, "x-position": 5 }, { "name": "$skip", "in": "query", "description": "Excludes the specified number of items of the queried collection from the result.", "schema": { "type": "integer", "format": "int32" }, "x-position": 6 }, { "name": "$count", "in": "query", "description": "Indicates whether the total count of items within a collection are returned in the result.", "schema": { "type": "boolean" }, "x-position": 7 } ], "responses": { "200": { "description": "Successfully returned list of audit reasons.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuditReasonCollectionResponse" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions/{fieldId}": { "get": { "tags": [ "FieldDefinitions" ], "summary": "Returns a single field definition object.", "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", "operationId": "GetFieldDefinition", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The requested field definition ID.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "culture", "in": "query", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.", "schema": { "type": "string", "default": "", "nullable": true }, "x-position": 3 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 4 } ], "responses": { "200": { "description": "Successfully returned requested field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinition" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "FieldDefinitions" ], "summary": "Updates properties of an existing field definition (partial update).", "description": "- Partial-update merge semantics. null = leave unchanged; \"\" = clear a string property.\n- FieldType cannot be changed via this endpoint — use the dedicated ChangeFieldType endpoint.\n- ListValues cannot be changed via this endpoint — use the dedicated ListValues endpoints.\n- Required OAuth scope: repository.Write", "operationId": "UpdateFieldDefinition", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The ID of the field definition to update.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "The properties to change. Only non-null properties are applied; null leaves the property unchanged. Empty string clears a string property.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFieldDefinitionRequest" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "Successfully updated the field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinition" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "FieldDefinitions" ], "summary": "Deletes a field definition from the repository.", "description": "- Deletes the specified field definition. Behavior when the field is referenced by templates or assigned to entries mirrors the underlying repository server response — if rejected by the server, the response surfaces the server error.\n- Required OAuth scope: repository.Write", "operationId": "DeleteFieldDefinition", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The ID of the field definition to delete.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "responses": { "204": { "description": "Successfully deleted the field definition." }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions": { "get": { "tags": [ "FieldDefinitions" ], "summary": "Returns the paged listing of the field definitions available in a repository.", "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", "operationId": "ListFieldDefinitions", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "Prefer", "x-originalName": "prefer", "in": "header", "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "culture", "in": "query", "description": "An optional query parameter used to indicate the locale that should be used for formatting. The value should be a standard language tag.", "schema": { "type": "string", "default": "", "nullable": true }, "x-position": 3 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 4 }, { "name": "$orderby", "in": "query", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", "schema": { "type": "string", "nullable": true }, "x-position": 5 }, { "name": "$top", "in": "query", "description": "Limits the number of items returned from a collection. The maximum value is 150.", "schema": { "type": "integer", "format": "int32" }, "x-position": 6 }, { "name": "$skip", "in": "query", "description": "Excludes the specified number of items of the queried collection from the result.", "schema": { "type": "integer", "format": "int32" }, "x-position": 7 }, { "name": "$count", "in": "query", "description": "Indicates whether the total count of items within a collection are returned in the result.", "schema": { "type": "boolean" }, "x-position": 8 } ], "responses": { "200": { "description": "Successfully returned field definitions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinitionCollectionResponse" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "FieldDefinitions" ], "summary": "Creates a new field definition in the repository.", "description": "- Creates a new metadata field definition with the supplied core attributes, flags, and (optionally) initial list values for list-backed fields.\n- Names must be unique within the repository; duplicate-name failures return 400.\n- Required OAuth scope: repository.Write", "operationId": "CreateFieldDefinition", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "The field definition to create. Name and FieldType are required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFieldDefinitionRequest" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Successfully created the field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinition" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions/{fieldId}/ListValues": { "get": { "tags": [ "FieldDefinitions" ], "summary": "Returns the list values configured on a list-backed field definition.", "description": "- Returns the field's configured list-item values in repository-configured order.\n- Applies only to list-backed fields; non-list fields return an empty array.\n- Required OAuth scope: repository.Read", "operationId": "GetFieldListValues", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The ID of the field definition.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Successfully returned the list values for the field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListValuesResponse" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "FieldDefinitions" ], "summary": "Replaces the list values for a list-backed field definition.", "description": "- Replaces the field's full list-item set wholesale. No partial add/remove endpoints are exposed.\n- Duplicates and empty-string values are rejected with 400.\n- Required OAuth scope: repository.Write", "operationId": "ReplaceFieldListValues", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The ID of the field definition.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "The new list of values. Order is preserved. Empty array clears the list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplaceListValuesRequest" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "Successfully replaced the list values for the field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListValuesResponse" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions/{fieldId}/ContainingTemplates": { "get": { "tags": [ "FieldDefinitions" ], "summary": "Returns the templates that contain the specified field definition.", "description": "- Lists template definitions that include the specified field. Useful before performing destructive operations on the field.\n- Required OAuth scope: repository.Read", "operationId": "GetFieldContainingTemplates", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The ID of the field definition.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "name": "$orderby", "in": "query", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", "schema": { "type": "string", "nullable": true }, "x-position": 5 }, { "name": "$count", "in": "query", "description": "Indicates whether the total count of items within a collection are returned in the result.", "schema": { "type": "boolean" }, "x-position": 6 } ], "responses": { "200": { "description": "Successfully returned the templates that contain the field definition.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TemplateDefinition" } } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions/{fieldId}/AssignedEntryCount": { "get": { "tags": [ "FieldDefinitions" ], "summary": "Returns the count of entries that have a value assigned for the specified field definition.", "description": "- Useful for impact analysis before performing destructive operations such as type changes or deletion.\n- Required OAuth scope: repository.Read", "operationId": "GetFieldAssignedEntryCount", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The ID of the field definition.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Successfully returned the count of entries assigned to the field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignedEntryCountResponse" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions/{fieldId}/Properties": { "get": { "tags": [ "FieldDefinitions" ], "summary": "Gets the custom-properties bag for a field definition.", "description": "- Returns the custom-properties bag persisted on the field definition. The bag is an opaque application-defined string → string map scoped to the definition itself (not to a user), useful for attaching integration metadata or application-specific configuration that belongs with the field — for example to encode list-field display preferences such as sort order, or to record an external system's identifier for the field.\n- Keys are application-defined; recommend a namespace prefix (e.g. com.acme.workflow.stage, myapp.kind) to avoid collisions across applications.\n- The response may include entries written by other applications or by system-managed tooling. Callers should leave unrecognized keys untouched on subsequent UpdateFieldProperties calls — round-tripping them in set preserves them, including them in remove deletes them.\n- Required OAuth scope: repository.Read", "operationId": "GetFieldProperties", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The ID of the field definition.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Successfully returned the extended properties for the field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPropertiesResponse" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "FieldDefinitions" ], "summary": "Partially updates the custom-properties bag for a field definition.", "description": "- Entries in set are written (creating or overwriting). Entries in remove are deleted. Properties not mentioned in either are left unchanged.\n- Empty set and empty remove is a no-op and returns the current bag.\n- Returns the full custom-properties bag after the change.\n- The bag is application-defined; the API does not validate key semantics. Recommend namespaced keys (e.g. com.acme.invoice.region, myapp.kind) to avoid collisions.\n- Required OAuth scope: repository.Write", "operationId": "UpdateFieldProperties", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The ID of the field definition.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "Set and/or remove entries on the property bag. Keys not mentioned are left unchanged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFieldPropertiesRequest" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "Successfully updated the extended properties for the field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldPropertiesResponse" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions/Merge": { "post": { "tags": [ "FieldDefinitions" ], "summary": "Merges two or more field definitions into a new field definition.", "description": "- Combines the values of the source fields into a new field. onConflict controls per-entry value conflicts: Fail (default) aborts on conflict, MakeMultivalue keeps all values, UseFirstField keeps the first and discards the rest.\n- UseFirstField is lossy and requires allowDataLoss = true; otherwise the request is rejected with 400.\n- removeFromTemplates (default false) also removes the source fields from any templates that contain them. The source field definitions themselves are preserved regardless — the merge creates a new field, it does not delete the originals. Callers that want the sources gone must call DeleteFieldDefinition on each after the merge succeeds.\n- autoRename (default false) asks the repository to auto-select a non-conflicting name on collision; whether the repository honors this for merges is version-dependent, so callers should pre-validate newFieldName and treat an \"already exists\" error as a genuine collision.\n- At least two source fields are required.\n- Required OAuth scope: repository.Write", "operationId": "MergeFields", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "The source field IDs (two or more), the new field name, and merge options.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MergeFieldsRequest" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Successfully merged the source fields into the new field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinition" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions/{fieldId}/ChangeType": { "post": { "tags": [ "FieldDefinitions" ], "summary": "Changes the data type of an existing field definition.", "description": "- Converts the field to newFieldType. The conversion can reset type-specific configuration (length, constraint, format), clear list items when leaving the List type, and clear a default value that cannot be reinterpreted in the new type. Entries already assigned the field may have their values dropped if the existing data cannot survive the new type's domain.\n- When the conversion would lose data, allowDataLoss = true is required; otherwise the request is rejected with 400. The server treats the conversion as lossy unless it is one of the explicit safe widenings (Date → DateTime, ShortInteger → LongInteger, ShortInteger → Number, LongInteger → Number) and clearing list items / resetting a constraint / dropping a default would not actually discard data. A field with assigned entries that is not undergoing one of the safe widenings is always treated as lossy.\n- Required OAuth scope: repository.Write", "operationId": "ChangeFieldType", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The ID of the field definition to convert.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "The target field type and the data-loss acknowledgement.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeFieldTypeRequest" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "Successfully changed the field definition's type.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldDefinition" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions/{fieldId}/AccessControl": { "get": { "tags": [ "AccessControl" ], "summary": "Returns the access control list (ACL) of a field definition.", "description": "- Returns the field's access control entries (ACEs): the trustee, whether rights are allowed or denied, and the rights themselves. Field ACEs have no scope and are never inherited.\n- The OAuth scope is coarse; the repository session enforces the real permission and returns 403 when the caller lacks the field's ReadPermissions right.\n- Required OAuth scope: repository.Read", "operationId": "GetFieldAccessControl", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The requested field definition ID.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "responses": { "200": { "description": "Successfully returned the field definition's access control list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldAccessControlList" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "AccessControl" ], "summary": "Replaces the access control list (ACL) of a field definition.", "description": "- Full replace: the supplied entries replace the field's entire explicit ACL. Inherited entries are not accepted (field ACEs are never inherited). Address a trustee by trustee.sid or trustee.accountName (the SID wins when both are given; an account name is resolved to a SID server-side).\n- The OAuth scope is coarse; the repository session enforces the real permission and returns 403 when the caller lacks the field's ChangePermissions right.\n- The entries property is required. A request body that does not include it is rejected with a 400; send an empty array to clear the list.\n- Required OAuth scope: repository.Write", "operationId": "SetFieldAccessControl", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The field definition ID whose ACL to replace.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 } ], "requestBody": { "x-name": "request", "description": "The access control entries to set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFieldAccessControlRequest" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "Successfully replaced the field definition's access control list. Returned the updated access control list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldAccessControlList" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions/{fieldId}/Rights": { "get": { "tags": [ "AccessControl" ], "summary": "Returns the rights to a field definition for the current session or a specified trustee.", "description": "- Returns the rights a trustee has on the field definition, plus whether the session is read-only. By default these are the effective rights (after group membership, allow/deny resolution, and the privilege overlay); set aclOnly=true for the rights granted by the field's own ACL without that overlay. Omit both trusteeId and trusteeName for the current session.\n- Required OAuth scope: repository.Read", "operationId": "GetFieldRights", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "fieldId", "in": "path", "required": true, "description": "The requested field definition ID.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "trusteeId", "in": "query", "description": "An optional trustee SID. When supplied, returns that trustee's rights; otherwise the current session's.", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "name": "trusteeName", "in": "query", "description": "An optional trustee account name, as an alternative to trusteeId. The SID wins when both are supplied.", "schema": { "type": "string", "nullable": true }, "x-position": 4 }, { "name": "aclOnly", "in": "query", "description": "Optional. Selects which rights are returned. Default (false): the trustee's effective rights — the net result after allow/deny resolution, group membership, and the repository's privilege overlay (for example, the metadata-management privilege that grants full control over every field regardless of its ACL). When true: only the rights granted by this field definition's own access control list, without that privilege overlay. Group membership is always resolved. Field definitions are not hierarchical, so there is no parent inheritance involved either way.", "schema": { "type": "boolean", "default": false }, "x-position": 5 } ], "responses": { "200": { "description": "Successfully returned the rights for the field definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldRights" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Field definition with specified id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/FieldDefinitions/DefaultAccessControl": { "get": { "tags": [ "AccessControl" ], "summary": "Returns the default access control list assigned to newly created field definitions.", "description": "- Returns the repository's default field ACL — the access control entries a new field definition inherits at creation time.\n- Required OAuth scope: repository.Read", "operationId": "GetDefaultFieldAccessControl", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "Successfully returned the default field access control list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldAccessControlList" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "AccessControl" ], "summary": "Replaces the default access control list assigned to newly created field definitions.", "description": "- Full replace: the supplied entries replace the entire default field ACL. Inherited entries are not accepted. Address a trustee by trustee.sid or trustee.accountName (the SID wins when both are given).\n- The entries property is required. A request body that does not include it is rejected with a 400; send an empty array to clear the list.\n- Required OAuth scope: repository.Write", "operationId": "SetDefaultFieldAccessControl", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "The access control entries to set as the default field ACL.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFieldAccessControlRequest" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Successfully replaced the default field access control list. Returned the updated default access control list.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FieldAccessControlList" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/LinkDefinitions": { "get": { "tags": [ "LinkDefinitions" ], "summary": "Returns the link definitions associated with a repository.", "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", "operationId": "ListLinkDefinitions", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "Prefer", "x-originalName": "prefer", "in": "header", "description": "An optional OData header. Can be used to set the maximum page size using odata.maxpagesize.", "schema": { "type": "string", "nullable": true }, "x-position": 2 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 3 }, { "name": "$orderby", "in": "query", "description": "Specifies the order in which items are returned. The maximum number of expressions is 5.", "schema": { "type": "string", "nullable": true }, "x-position": 4 }, { "name": "$top", "in": "query", "description": "Limits the number of items returned from a collection. The maximum value is 150.", "schema": { "type": "integer", "format": "int32" }, "x-position": 5 }, { "name": "$skip", "in": "query", "description": "Excludes the specified number of items of the queried collection from the result.", "schema": { "type": "integer", "format": "int32" }, "x-position": 6 }, { "name": "$count", "in": "query", "description": "Indicates whether the total count of items within a collection are returned in the result.", "schema": { "type": "boolean" }, "x-position": 7 } ], "responses": { "200": { "description": "Successfully returned link definitions.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkDefinitionCollectionResponse" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/LinkDefinitions/{linkDefinitionId}": { "get": { "tags": [ "LinkDefinitions" ], "summary": "Returns a single link definition object.", "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", "operationId": "GetLinkDefinition", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "linkDefinitionId", "in": "path", "required": true, "description": "The requested link definition ID.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "$select", "in": "query", "description": "Limits the properties returned in the result.", "schema": { "type": "string", "nullable": true }, "x-position": 3 } ], "responses": { "200": { "description": "Successfully returned specified link definition.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkDefinition" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Link definition with the specfied id was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/Entries/CreateMultipartUploadUrls": { "post": { "tags": [ "Entries" ], "summary": "Requests Upload URLs to upload a large file in chunks.", "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", "operationId": "CreateMultipartUploadUrls", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 } ], "requestBody": { "x-name": "request", "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMultipartUploadUrlsRequest" }, "examples": { "1": { "summary": "Request the first batch of URLs", "description": "The body of the CreateMultipartUploadUrls request for requesting a batch of 5 URLs, as the first batch.", "value": { "startingPartNumber": 1, "numberOfParts": 5, "fileName": "Sample.pdf", "mimeType": "application/pdf" } }, "2": { "summary": "Request the second batch of URLs", "description": "The body of the CreateMultipartUploadUrls request for requesting a batch of 5 URLs, as the second batch. The value of UploadId should be the same as the one received in the response of the first request. Any value sent for FileName or MimeType is ignored.", "value": { "uploadId": "VXBsb2FkSWRGcm9tRmlyc3RSZXF1ZXN0", "startingPartNumber": 6, "numberOfParts": 5 } }, "3": { "summary": "Request the third batch of URLs", "description": "The body of the CreateMultipartUploadUrls request for requesting a batch of 5 URLs, as the third batch. The value of UploadId should be the same as the one received in the response of the first request. Any value sent for FileName or MimeType is ignored.", "value": { "uploadId": "VXBsb2FkSWRGcm9tRmlyc3RSZXF1ZXN0", "startingPartNumber": 11, "numberOfParts": 5 } } } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Returned response containing an upload ID and an array of upload URLs.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMultipartUploadUrlsResponse" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Requested repository was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "413": { "description": "Request is too large.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "An unexpected server-side error occurred.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/Entries/{entryId}/Folder/ImportUploadedParts": { "post": { "tags": [ "Entries" ], "summary": "Starts an asynchronous import task to import a document into a folder.", "description": "- Imports a new document from previously uploaded parts into the specified folder. The parts are assembled server-side into a single file that is then processed like a direct import.\n- The uploadId is obtained from the CreateMultipartUploadUrls response. The partETags are the ETag values returned by S3 when uploading each file chunk to the pre-signed upload URLs, and should be provided in the order of their associated upload URLs.\n- The assembled file is imported as either the electronic document or image pages, following the same rules as the synchronous POST /Folder/Import:\n - If the file extension is not in {txt, tif, tiff, bmp, pcx, jpg, jpeg, gif, png}, or if `importAsElectronicDocument=true`, the file is stored as the electronic document. For supported edoc formats, `pdfOptions.generatePages` additionally produces server-rendered image pages, and `pdfOptions.generateText` triggers text extraction from the document (or OCR when the source is image-based).\n - Otherwise (image extension with `importAsElectronicDocument=false`), the file is imported as image pages. `pdfOptions.generateText` triggers OCR for the resulting pages.\n- Metadata in the body is assigned to the newly created entry.\n- Supports assembled files up to 64 GB — use this endpoint when the file exceeds the size or time limits of the synchronous POST /Folder/Import.\n- Returns 202 Accepted with a task ID. Poll the task endpoint for progress and completion. This route does not support partial success.\n- `imageFiles` and `generateImagePagesText` are not supported on this endpoint; use the synchronous POST /Folder/Import to attach image pages alongside the imported file.\n- Required OAuth scope: repository.Write", "operationId": "StartImportUploadedParts", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "description": "The entry ID of the folder that the document will be created in.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "autoCreateFolderPath", "in": "query", "description": "When true, any missing folders in the request's `folderPath` are created; when false (default), a missing folder returns 404.", "schema": { "type": "boolean", "default": false }, "x-position": 4 }, { "name": "culture", "in": "query", "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.", "schema": { "type": "string", "default": "", "nullable": true }, "x-position": 5 } ], "requestBody": { "x-name": "request", "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartImportUploadedPartsRequest" } } }, "x-position": 3 }, "responses": { "202": { "description": "Operation was started successfully. Returned a long operation task ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartTaskResponse" } } } }, "400": { "description": "Invalid or bad request.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Access denied for the operation.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Requested repository was not found.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Access token is invalid or expired.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "413": { "description": "Request is too large.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Rate limit is reached.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "500": { "description": "Import operation failed due to an internal server error. See error for details.", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/v2/Repositories/{repositoryId}/Entries/{entryId}/ExportAsync": { "post": { "tags": [ "Entries" ], "summary": "Starts an asynchronous export task to export an entry.", "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- When part=Text, a document whose pages carry no text stream is rejected with 400 rather\n than started and failed later. Text is extracted asynchronously after an import, so a\n document may briefly have pages but no text; poll hasText on ListPageInfos and retry once\n it reports true. A document with no pages at all is not rejected here.\n- The download link the completed task carries in result.uri is **single-use**. The first\n GET returns the file; any later GET of the same link answers 404, and that 404 carries no\n problem details because it comes from the download service rather than from this API.\n Save the content on the first download, and start a new export if a download has to be\n retried.\n- Required OAuth scope: repository.Read", "operationId": "StartExportEntry", "parameters": [ { "name": "repositoryId", "in": "path", "required": true, "description": "The requested repository ID.", "schema": { "type": "string" }, "x-position": 1 }, { "name": "entryId", "in": "path", "required": true, "description": "The ID of entry to export.", "schema": { "type": "integer", "format": "int32" }, "x-position": 2 }, { "name": "pageRange", "in": "query", "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 or part=AlternateEdoc.", "schema": { "type": "string", "nullable": true }, "x-position": 3 } ], "requestBody": { "x-name": "request", "description": "The request body.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StartExportEntryRequest" }, "examples": { "1": { "summary": "Export the image part of a Laserfiche Document", "description": "The body of the export request includes:Note: Please enter below the clientId/clientSecret of a registered web application, or the clientId of a SPA. For SPA, the clientSecret field must be left empty. The app, either a web application or SPA, must have the following uri defined as its redirect uri.
https://api.laserfiche.com/repository/swagger/oauth2-redirect.html
For more information, see this page
", "flows": { "authorizationCode": { "authorizationUrl": "https://signin.laserfiche.com/oauth/Authorize", "tokenUrl": "https://signin.laserfiche.com/oauth/Token", "scopes": { "repository.Read": "Allows the app to read the content of Laserfiche repositories on behalf of the signed-in user.", "repository.Write": "Allows the app to modify the content of Laserfiche repositories on behalf of the signed-in user." } } } } } }, "security": [ { "Authorization": [] }, { "OAuth2 Authorization Code Flow": [ "repository.Read", "repository.Write" ] } ] }