Task Creator
Version: 1.0.0 OpenAPI: 3.0.3
Workcloud Task Management Creator APIs let an external system configure work, create projects, approve them, and read or update them after launch.
This specification is the customer-facing contract for the Workcloud Task Management Creator APIs on the Zebra developer portal. It keeps the Creator operations already published on that page and adds new Creator operations documented in this specification.
What you need
- An active Zebra Workcloud Task Management customer environment.
- A Trial or Product API key from your Zebra representative. A Trial key is for non-production use, is valid for 6 months, and can be renewed through your representative.
- The API host issued with that key. Development and test hosts are listed in this document. Obtain the key with the OAuth 2.0 client-credentials flow described on the developer portal, then send it on every request in the
apikeyheader.
Operations whose summary ends with * are new. These operations require a Workcloud Task Management environment that supports them.
Recommended sequence
The sections in this document follow the same order.
- Project type. A project type is the setup for one kind of project. It decides which fields the project uses, whether it has tasks, files, store rollout, and approval, and which organization levels can run it. Create a project type with
POST /tm/v1/project-types/create, or select one that already exists fromPOST /tm/api/v1/project-types. When you create a project, send that project type's code intype. - Template. List completed templates and their tasks when the project should start from a template. Create the project with
POST /tm/v1/projects. Sendtemplate_idto copy the template into the new project. Omittemplate_idto create the project from scratch. - Project. Create the project with
POST /tm/v1/projects. List projects for a user withGET /tm/v1/projects. Create a plan from an XML file withPOST /tm/api/v1/plans/create/from-xml. - Upload (optional). When the project or a task needs a file, upload it first with
POST /tm/v1/uploadsand pass the returnedresource_idon create or edit. Eachresource_idis valid for 24 hours. A single upload request accepts up to 4 files. Skip this call when there is no file. - Approval. List the inbox, read the actions allowed for one item, then approve, reject, or comment.
- Details. Read the project with
GET /tm/v1/projects/{id}. - Edit. Change the project with
PUT /tm/v1/projects/{id}. A change that requires review goes through approval again. - Project action. Recall, withdraw, complete, or delete a draft project.
Paths
New operations use /tm/v1. Calls already published on the developer portal use /tm/api/v1.
The environment is identified by the API key. Do not send a tenant or domain id on /tm/v1 calls. XML project creation and XML plan creation still require domainId in the form body.
Field names
New operations use snake_case JSON. Existing operations keep the field names already published for them, including camelCase fields such as projectId and actionFlag.
Authentication
Send the API key in the apikey header.
Idempotency
POST and PUT calls on the new operations require an Idempotency-Key header (UUID). Send the same key and the same body to retry a call that already succeeded. Sending the same key with a different body is rejected. Use a new key for a new business action.
Errors
An error response is JSON with type, code, and message. It includes param when a specific field caused the failure. A caller error uses a 4xx status. A server error uses a 5xx status.
New operations in this specification return either a single error object or, when more than one field fails validation, an errors array. GET /tm/v1/projects (project list) always returns a single error object. Approval take-action can return an errors array on 422 when pre-validation finds multiple blocking issues. Older operations already on the developer portal may return status and error, or META and DATA, instead of this shape.
Servers
| URL | Description |
|---|---|
https://dev-api.zebra.com | Development |
https://test-api1.zebra.com | Test |
https://stage-api.zebra.com | Staging |
https://api.zebra.com | Production |
Security schemes
| Name | Type | Description |
|---|---|---|
ApiKeyAuth | apiKey | API key issued for the customer environment. Send it in the apikey header. Obtain the key from your Zebra representative using the OAuth 2.0 client-credentials flow on the developer portal. |
Operations
Use the sidebar to browse individual operations generated from this specification.