- V1
-
V2
- Admin
- Common
- Custom-Themes
- Dashboard
- DataModel
- Dataset
- Datasource
- Documents
- Draft
- Identity
- Identity-Organization
- Identity-Role
- Identity-Token
- Identity-User
- K8s
- Language-Packages
- Languages
- QueueMonitor
- Reporting-CachingSettings
- Reporting-ExportTemplates
- Reporting-RenderResults
- Reporting-Reports
- Reporting-UserFunctions
- Scene
- Scheduler
- Shared-Resources
- Tags
- overview
Draft
Draft
[GET] /api/v2/common/drafts/{draftId}
Retrieves detailed information about a specific draft document by its ID.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| draftIdRequired | string | path | The unique identifier of the draft document to retrieve. Example: e3808c7e-c0e7-44da-96a2-200b3bb216c6 |
| extendQuery | ExtendQuery | query | Detail level for query response. Example: References,Revisions |
| includeIndirectReference | Boolean | query | Indicates whether to include indirect references in the response. Example: true |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[DELETE] /api/v2/common/drafts/{draftId}
Delete document draft
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| draftIdRequired | string | path | Draft Id |
Response
Status Code: 204
No Content
Status Code: 400
Bad Request
Status Code: 404
Not Found
[GET] /api/v2/common/drafts
Retrieves a list of draft documents based on the specified types.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| types | string | query | A comma-separated list of document types to filter the drafts. If empty, defaults to predefined types. Example: "article,report" |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
[GET] /api/v2/common/drafts/publish-requests/{publishRequestId}
Retrieves detailed information about a specific publish request by its ID.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| publishRequestIdRequired | string | path | The unique identifier of the publish request to retrieve. Example: e3808c7e-c0e7-44da-96a2-200b3bb216c6 |
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[GET] /api/v2/common/drafts/publish-requests
Retrieves a list of publish requests based on the specified document types and publish request type.
Parameters
| Name | Type | Located In | Description |
|---|---|---|---|
| types | string | query | A comma-separated list of document types to filter the publish requests. If empty, defaults to predefined types. Example: "dbd,rdl" |
| prType | string | query | The type of publish request to filter. Example: "urgent" |
Response
Status Code: 200
Success
GetPublishRequestsInfoResponseModel
Status Code: 400
Bad Request
[POST] /api/v2/common/drafts/publish-requests
Creates a publish request for a specified draft document. This method is responsible for initiating the process to move a document from draft to published status by creating a publish request.
Request Schema
Response
Status Code: 200
Success
CreatePublishRequestResponseModel
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/common/drafts/publish-requests/approve
Approves a publish request. This method is responsible for approving a publish request, which will move the document from its current state to a published state, making it available for public or specified viewers. This is a crucial step in the document lifecycle management, ensuring that only reviewed and approved documents are published.
Request Schema
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
[POST] /api/v2/common/drafts/publish-requests/reject
Rejects a publish request. This method is responsible for rejecting a publish request, which will prevent the document from moving from its current state to a published state. This is an important step in the document lifecycle management, ensuring that documents that do not meet the required standards or criteria are not published.
Request Schema
Response
Status Code: 200
Success
Status Code: 400
Bad Request
Status Code: 404
Not Found
Models
Ƭ ExtendQuery
Enum:
NoneEffectiveOpsSecurityReferencesRevisionsTagsDraftAll
Defines the options for extending a document query with additional information.
This enumeration allows for specifying which additional data should be included in a document query response.
It supports bitwise operations to combine multiple options.
* None - 0 - No additional data is included.
* EffectiveOps - 1 - Includes effective operations applicable to the document.
* Security - 2 - Includes security information such as access control lists.
* References - 4 - Includes references to other documents.
* Revisions - 8 - Includes information about document revisions.
* Tags - 16 - Includes tags associated with the document.
* Draft - 32 - Includes draft information associated with the document.
* All - 63 - Includes all available extended information.
Ƭ DraftVO
Represents a view model for a draft document, encapsulating all relevant information and metadata associated with a draft.
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | The unique identifier of the draft. | |
| typeNullable | string | The type of the draft. | |
| titleNullable | string | The title of the draft. | |
| displayNameNullable | string | The display name of the draft. | |
| descriptionNullable | string | A brief description of the draft. | |
| extNullable | string | The file extension of the draft document. | |
| createdBy | SampleUserResponseModel | ||
| createdNullable | ISO DateTime Sting | The date and time when the draft was created. | |
| isDraft | Boolean | Indicates whether the document is a draft. | |
| isApproval | Boolean | Indicates whether the draft requires approval. | |
| contentTypeNullable | string | The content type of the draft. | |
| contentUrlNullable | string | The URL to access the content of the draft. | |
| revisionNo | int32 | The revision number of the draft. | |
| revisionContentUrlNullable | string | The URL to access the content of the specific revision of the draft. | |
| isSystemReserved | Boolean | Indicates whether the draft is reserved by the system. | |
| hideOnMobile | Boolean | Indicates whether the draft should be hidden on mobile devices. | |
| metaNullable | string | Metadata associated with the draft. | |
| hideInDocumentPortal | Boolean | Indicates whether the draft should be hidden in the document portal. | |
| isResource | Boolean | Indicates whether the document is considered a resource. | |
| organizationIdNullable | string | The identifier of the organization associated with the draft. | |
| organizationIdPathNullable | string | The path of organization identifiers associated with the draft. | |
| thumbnailNullable | string | The URL to the thumbnail image of the draft. | |
| modifiedNullable | ISO DateTime Sting | The date and time when the draft was last modified. | |
| modifiedBy | SampleUserResponseModel | ||
| customPermissionsNullable | Array<string> |
A list of custom permissions associated with the draft. | |
| effectiveOpsNullable | string | The effective operations that can be performed on the draft. | |
| security | SecurityResponseModel | ||
| referencesNullable | ReferenceResponseModel | A list of references associated with the draft. | |
| revisionsNullable | RevisionResponseModel | A list of revisions of the draft. |
Ƭ SampleUserResponseModel
Represents a simplified model of a user, providing essential information used in various response models.
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | The unique identifier of the user. | |
| nameNullable | string | The name of the user. |
Ƭ SecurityResponseModel
Security settings for a document.
| Name | Type | Description | Example |
|---|---|---|---|
| ownerIdNullable | string | Owner's unique identifier. | |
| permissionsNullable | AclEntryQueryModel | Document access permissions. |
Ƭ ReferenceResponseModel
Represents a model for a document reference, including details about the document and its permissions.
| Name | Type | Description | Example |
|---|---|---|---|
| documentIdNullable | string | The unique identifier of the referenced document. | |
| resourceNameNullable | string | The name of the resource the document is associated with. | |
| resourceDocTypeNullable | string | The type of the resource document. | |
| resourceDocNameNullable | string | The name of the resource document. | |
| displayNameNullable | string | The display name for the reference. | |
| metaNullable | string | Metadata associated with the document. | |
| documentRevNullable | string | The revision of the document. | |
| isDirectChild | Boolean | Indicates whether the document is a direct child of the parent document. | |
| permissionNullable | string | The permission level on the document. | |
| contentUrlNullable | string | The URL to access the content of the document. | |
| minimalPermissionNullable | string | The minimal permission required to access the document. |
Ƭ RevisionResponseModel
Represents a model for a document revision, including details such as revision number, comments, metadata, and associated user information.
| Name | Type | Description | Example |
|---|---|---|---|
| no | int32 | The revision number. This is typically an integer that increments with each new revision. | |
| commentNullable | string | A comment describing the changes made in this revision. | |
| metaNullable | string | Metadata associated with the revision, potentially including details like tags or keywords. | |
| createdBy | SampleUserResponseModel | ||
| createdNullable | ISO DateTime Sting | The date and time when this revision was created. | |
| modifiedBy | SampleUserResponseModel | ||
| modifiedNullable | ISO DateTime Sting | The date and time when this revision was last modified. | |
| contentUrlNullable | string | The URL to access the content of this revision. | |
| referencesNullable | ReferenceResponseModel | A list of references associated with this revision, such as related documents or resources. |
Ƭ AclEntryQueryModel
Defines ACL entry permissions for a sub-role.
| Name | Type | Description | Example |
|---|---|---|---|
| sub | RoleResponseModel | ||
| opsNullable | Array<string> |
Authorized operations. | |
| opflags | int32 | Operation flags for additional control. |
Ƭ RoleResponseModel
Represents a role within the system.
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | Unique identifier of the role. | |
| nameNullable | string | Name of the role. | |
| typeNullable | string | Type of the role. |
Ƭ ServerPluginError
Server plugin error
| Name | Type | Description | Example |
|---|---|---|---|
| codeNullable | string | error code | |
| messageNullable | string | error message | |
| contextNullable | string | error context | |
| innerError | ServerPluginError | ||
| extensionsNullable | any | Extended result |
Ƭ GetDraftsInfoResponseModel
Represents the response model for the GetDraftsInfo operation, containing a collection of draft documents.
| Name | Type | Description | Example |
|---|---|---|---|
| draftsNullable | DraftVO | An enumerable collection of Grapecity.Enterprise.Server.V2.Models.DraftVO objects representing the draft documents. |
Ƭ PublishRequestVO
Represents a request to publish a document, including details about the document, its approval status, and associated metadata.
| Name | Type | Description | Example |
|---|---|---|---|
| idNullable | string | The unique identifier of the publish request. | |
| titleNullable | string | The title of the document associated with the publish request. | |
| displayNameNullable | string | The display name of the document associated with the publish request. | |
| draftIdNullable | string | The draft identifier of the document associated with the publish request. | |
| status | int32 | The status of the publish request, represented as an integer. | |
| docTypeNullable | string | The type of the document associated with the publish request. | |
| commitNullable | string | The commit identifier associated with the document version to be published. | |
| modifiedBy | SampleUserResponseModel | ||
| approvedBy | SampleUserResponseModel | ||
| createdBy | SampleUserResponseModel | ||
| modifiedNullable | ISO DateTime Sting | The date and time when the publish request was last modified. | |
| approvedNullable | ISO DateTime Sting | The date and time when the publish request was approved. | |
| createdNullable | ISO DateTime Sting | The date and time when the publish request was created. | |
| effectiveOpsNullable | string | The effective operations associated with the publish request. | |
| draft | DraftVO | ||
| documentIdNullable | string | The document identifier associated with the publish request. |
Ƭ GetPublishRequestsInfoResponseModel
Represents the response model for the GetPublishRequestsInfo operation, containing a collection of publish request information.
| Name | Type | Description | Example |
|---|---|---|---|
| publishRequestsInfoNullable | PublishRequestVO | An enumerable collection of Grapecity.Enterprise.Server.V2.Models.PublishRequestVO objects representing the detailed information of each publish request. |
Ƭ CreatePublishRequestResponseModel
Represents the response model for a create publish request operation. This model includes the unique identifier of the newly created publish request.
| Name | Type | Description | Example |
|---|---|---|---|
| publishRequestIdNullable | string | The unique identifier of the publish request that was created. |
Ƭ CreatePublishRequestModel
Represents the request model for creating a publish request for a draft document. This model is used to initiate the process of publishing a document by providing the draft document's unique identifier.
| Name | Type | Description | Example |
|---|---|---|---|
| draftIdNullable | string | Gets or sets the unique identifier of the draft document to be published. |
Ƭ DoApproveResponseModel
Represents the response model for a document approval operation. This model includes the outcome of the approval process and the unique identifier of the document that was approved.
| Name | Type | Description | Example |
|---|---|---|---|
| success | Boolean | Indicates whether the approval operation was successful. | |
| documentIdNullable | string | The unique identifier of the document that was approved. |
Ƭ PublishRequestModel
Represents the model for a request to publish a document. This model includes the publish request identifier and an optional commit message.
| Name | Type | Description | Example |
|---|---|---|---|
| publishRequestIdNullable | string | Gets or sets the unique identifier of the publish request. | |
| commitNullable | string | Gets or sets the commit message associated with the publish request. This message can provide context or a description of the changes being published. |
Ƭ DoRejectResponseModel
Represents the response model for a document rejection operation. This model includes the outcome of the rejection process, indicating whether the rejection was successful.
| Name | Type | Description | Example |
|---|---|---|---|
| success | Boolean | Indicates whether the rejection operation was successful. |