Platform | Draft

Service to manage entities of type 'Draft'.

Overview

api/{tenantKey}/{orgKey}/corePatterns/drafts

URL	api/{tenantKey}/{orgKey}/corePatterns/drafts
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
PUT:
DELETE:
- DELETE Draft by identifier
- DELETE Draft by key

All Resources

This service uses the following resources:

ApiDraftResource
DraftDataResource
DraftResource
DraftsGroupData

GET Operations

GET Drafts

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See DraftResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts

GET /corePatterns/drafts

GET Drafts (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See DraftResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts?page={page}&pageSize={pageSize}

GET /corePatterns/drafts?page={page}&pageSize={pageSize}

GET Draft by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See DraftResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{id}

GET /corePatterns/drafts/{id}

GET Draft by key

Returns the entity record that matches the specified key.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.

Response:

When successful, the response body contains the entity record. See DraftResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}

GET /corePatterns/drafts/{draftId}/{key}/{type}

GET Print Draft by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{id}/print?template={template}

GET /corePatterns/drafts/{id}/print?template={template}

GET Print Draft by key

Prints the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/print

GET /corePatterns/drafts/{draftId}/{key}/{type}/print

GET Original Print DraftOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{id}/printOriginal?template={template}

GET /corePatterns/drafts/{id}/printOriginal?template={template}

GET Original Print Draft by key

Prints the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/printOriginal

GET /corePatterns/drafts/{draftId}/{key}/{type}/printOriginal

GET Get Total Drafts

Get the total drafts.

The following elements are required:

operation	(string) The operation.
state	(string) The state.

Response:

When successful, the response body contains an item of type 'number'.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/getTotalDrafts

GET /corePatterns/drafts/getTotalDrafts

GET Get Drafts From Group Ex

Custom operation 'GetDraftsFromGroupEx'.

The following elements are required:

minDate	(DateTimeOffset) The min date.
maxDate	(DateTimeOffset) The max date.
operation	(string) The operation.
state	(string) The state.
maxSize	(int) The maxsize number.

Response:

When successful, the response body contains a list of resources of type 'DraftDataResource'. See DraftDataResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/getDraftsFromGroupEx

GET /corePatterns/drafts/getDraftsFromGroupEx

GET Get All Drafts Time Groups Ex

Custom operation 'GetAllDraftsTimeGroupsEx'.

The following elements are required:

operation	(string) The operation.
state	(string) The state.

Response:

When successful, the response body contains a list of resources of type 'DraftsGroupData'. See DraftsGroupData.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/getAllDraftsTimeGroupsEx

GET /corePatterns/drafts/getAllDraftsTimeGroupsEx

POST Operations

POST Drafts

Creates a new entity record.

The following elements are required:

draftResource

(ApiDraftResource) The request body should contain the entity record that should be created.
See ApiDraftResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiDraftResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts

POST /corePatterns/drafts

POST Delete Drafts From Group

Custom operation 'DeleteDraftsFromGroup'.

The following elements are required:

minDate	(DateTimeOffset) The min date.
maxDate	(DateTimeOffset) The max date.
operation	(string) The operation.
openedDraftKey	(Guid) The key for the opened draft.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/deleteDraftsFromGroup

POST /corePatterns/drafts/deleteDraftsFromGroup

POST Clear All Drafts

Custom operation 'ClearAllDrafts'.

The following elements are required:

openDraftKey

(Guid) OpenDraftKey.

Response:

When successful, the response body is empty.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/clearAllDrafts

POST /corePatterns/drafts/clearAllDrafts

PUT Operations

PUT Set ControllerName Draft

Updates the value of attribute 'ControllerName' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/controllerName

PUT /corePatterns/drafts/{draftId}/{key}/{type}/controllerName

PUT Set Description Draft

Updates the value of attribute 'Description' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/description

PUT /corePatterns/drafts/{draftId}/{key}/{type}/description

PUT Set DraftId Draft

Updates the value of attribute 'DraftId' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/draftId

PUT /corePatterns/drafts/{draftId}/{key}/{type}/draftId

PUT Set IsActive Draft

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/isActive

PUT /corePatterns/drafts/{draftId}/{key}/{type}/isActive

PUT Set Key Draft

Updates the value of attribute 'Key' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/key

PUT /corePatterns/drafts/{draftId}/{key}/{type}/key

PUT Set ModuleName Draft

Updates the value of attribute 'ModuleName' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/moduleName

PUT /corePatterns/drafts/{draftId}/{key}/{type}/moduleName

PUT Set Operation Draft

Updates the value of attribute 'Operation' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/operation

PUT /corePatterns/drafts/{draftId}/{key}/{type}/operation

PUT Set OperationName Draft

Updates the value of attribute 'OperationName' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/operationName

PUT /corePatterns/drafts/{draftId}/{key}/{type}/operationName

PUT Set OperationType Draft

Updates the value of attribute 'OperationType' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/operationType

PUT /corePatterns/drafts/{draftId}/{key}/{type}/operationType

PUT Set ParentId Draft

Updates the value of attribute 'ParentId' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(Guid) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/parentId

PUT /corePatterns/drafts/{draftId}/{key}/{type}/parentId

PUT Set ProcessCaption Draft

Updates the value of attribute 'ProcessCaption' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/processCaption

PUT /corePatterns/drafts/{draftId}/{key}/{type}/processCaption

PUT Set ProcessColor Draft

Updates the value of attribute 'ProcessColor' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/processColor

PUT /corePatterns/drafts/{draftId}/{key}/{type}/processColor

PUT Set RoleKey Draft

Updates the value of attribute 'RoleKey' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/roleKey

PUT /corePatterns/drafts/{draftId}/{key}/{type}/roleKey

PUT Set ServiceName Draft

Updates the value of attribute 'ServiceName' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/serviceName

PUT /corePatterns/drafts/{draftId}/{key}/{type}/serviceName

PUT Set State Draft

Updates the value of attribute 'State' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/state

PUT /corePatterns/drafts/{draftId}/{key}/{type}/state

PUT Set Title Draft

Updates the value of attribute 'Title' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/title

PUT /corePatterns/drafts/{draftId}/{key}/{type}/title

PUT Set Type Draft

Updates the value of attribute 'Type' in the specified entity record.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}/type

PUT /corePatterns/drafts/{draftId}/{key}/{type}/type

DELETE Operations

DELETE Draft by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{id}

DELETE /corePatterns/drafts/{id}

DELETE Draft by key

Deletes the entity record that matches the specified key.

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/drafts/{draftId}/{key}/{type}

DELETE /corePatterns/drafts/{draftId}/{key}/{type}

Resources

ApiDraftResource

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
controllerName	(string) The controller name for the draft.
operation	(string) The draft's operation.
timestamp	(string) The draft's timestamp.
url	(string) The draft's url.

The following elements are optional:

title	(string) The title for the draft.
description	(string) The description for the draft.
parentId	(Guid) The draft's parent identifier.
operationType	(string) The draft's operation type.
state	(string) The draft's state.
processColor	(string) The draft's process color.
processCaption	(string) The draft's process caption.
moduleName	(string) The draft's module name.
serviceName	(string) The draft's service name.
operationName	(string) The draft's operation name.
roleKey	(string) Role.

DraftDataResource

The following elements are required:

key	(string) The key for the draft.
draftId	(Guid) The draft identifier.
timestamp	(string) The draft's timestamp.
url	(string) The draft's url.

The following elements are optional:

processCaption	(string) The draft's process caption.
processColor	(string) The draft's process color.
description	(string) The description for the draft.
title	(string) The title for the draft.

DraftResource

The following elements are required:

draftId	(Guid) The draft identifier.
key	(string) The key for the draft.
type	(string) The draft's object type.
controllerName	(string) The controller name for the draft.
operation	(string) The draft's operation. (fk) Allowed value: the natural key of a record of type Operation. These records are accessibly through the Operations service.
timestamp	(string) The draft's timestamp.
url	(string) The draft's url.

The following elements are optional:

title	(string) The title for the draft.
description	(string) The description for the draft.
parentId	(Guid) The draft's parent identifier.
operationType	(string) The draft's operation type.
state	(string) The draft's state.
processColor	(string) The draft's process color.
processCaption	(string) The draft's process caption.
moduleName	(string) The draft's module name.
serviceName	(string) The draft's service name.
operationName	(string) The draft's operation name.
roleKey	(string) Role.

DraftsGroupData

The following elements are required:

caption	(string) The caption for the draft group.
total	(int) The draft group's total.
from	(DateTimeOffset) The inicial date.
to	(DateTimeOffset) The end date.