mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-05-12 17:04:57 +00:00
ea2c0ce229
* integrate JS-API with monorepo * [ci:force] fix token issue [ci:force] migrate docs folder [ci:force] clean personal tokens * [ci:force] gha workflow support * [ci:force] npm publish target * fix js-api test linting * [ci:force] fix test linting, mocks, https scheme * [ci:force] fix https scheme * [ci:force] typescript mappings * [ci:force] update scripts * lint fixes * linting fixes * fix linting * [ci:force] linting fixes * linting fixes * [ci:force] remove js-api upstream and corresponding scripts * [ci:force] jsdoc fixes * fix jsdoc linting * [ci:force] jsdoc fixes * [ci:force] jsdoc fixes * jsdoc fixes * jsdoc fixes * jsdoc fixes * [ci:force] fix jsdoc * [ci:force] reduce code duplication * replace 'chai' expect with node.js assert * replace 'chai' expect with node.js assert * [ci:force] remove chai and chai-spies for js-api testing * [ci:force] cleanup and fix imports * [ci:force] fix linting * [ci:force] fix unit test * [ci:force] fix sonar linting findings * [ci:force] switch activiti api models to interfaces (-2.5% reduction of bundle) * [ci:force] switch activiti api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch AGS api models to interfaces * [ci:force] switch search api models to interfaces * [ci:force] switch content api models to interfaces where applicable
3.2 KiB
3.2 KiB
ChecklistsApi
All URIs are relative to /activiti-app/api
| Method | HTTP request | Description |
|---|---|---|
| addSubtask | POST /enterprise/tasks/{taskId}/checklist | Create a task checklist |
| getChecklist | GET /enterprise/tasks/{taskId}/checklist | Get checklist for a task |
| orderChecklist | PUT /enterprise/tasks/{taskId}/checklist | Change the order of items on a checklist |
addSubtask
TaskRepresentation addSubtask(taskIdtaskRepresentation)
Create a task checklist
Example
import ChecklistsApi from 'ChecklistsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let checklistsApi = new ChecklistsApi(this.alfrescoApi);
checklistsApi.addSubtask(taskIdtaskRepresentation).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| taskId | string | taskId | |
| taskRepresentation | TaskRepresentation | taskRepresentation |
Return type
getChecklist
ResultListDataRepresentationTaskRepresentation getChecklist(taskId)
Get checklist for a task
Example
import ChecklistsApi from 'ChecklistsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let checklistsApi = new ChecklistsApi(this.alfrescoApi);
checklistsApi.getChecklist(taskId).then((data) => {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| taskId | string | taskId |
Return type
ResultListDataRepresentationTaskRepresentation
orderChecklist
orderChecklist(taskIdorderRepresentation)
Change the order of items on a checklist
Example
import ChecklistsApi from 'ChecklistsApi';
import { AlfrescoApi } from '@alfresco/js-api';
this.alfrescoApi = new AlfrescoApi();
this.alfrescoApi.setConfig({
hostEcm: 'http://127.0.0.1:8080'
});
let checklistsApi = new ChecklistsApi(this.alfrescoApi);
checklistsApi.orderChecklist(taskIdorderRepresentation).then(() => {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| taskId | string | taskId | |
| orderRepresentation | ChecklistOrderRepresentation | orderRepresentation |
Return type
null (empty response body)