Zebra Workcloud APIs
HomeGuidesAPI ReferenceSwagger
OpenAPI downloadsDeveloper Portal

Reference

  • Workcloud Sync

    • To-Dos
      • Overview
      • Add a comment to a To-Do
      • Adds a watcher to a To-Do
      • Create a draft copy of an existing To-Do
      • Create a To-Do
      • Create an announcement
      • Create survey
      • Creates a clone for a given To-Do for editing
      • Delete a draft To-Do
      • Deletes an announcement
      • Deletes the comment for the given comment ID
      • Discards a To-Do Edit
      • fetch answers
      • Fetch history details for the given history ID
      • Fetch questions for survey
      • Fetch the history list for the specified assignment ID
      • Fetch the history list for the specified To-Do ID
      • Fetch To-Dos assigned to a user
      • Fetch To-Dos created by user
      • Get To-Do assignments for Recall or Reset
      • Gets list of comments
      • Gets To-Do details
      • Launches a To-Do
      • Launches an announcement
      • Reassign assignment
      • Recall a To-Do
      • Reset a To-Do
      • Update a To-Do
      • Update an announcement
      • Update assigned To-Do status
      • Update checklist item
    • Comms
      • Overview
      • Cancel a help request
      • Create a new help request
      • Create Forum
      • Create Forum Post
      • Create Group
      • Delete Access Points for a tenant
      • Delete Group
      • Download access points as CSV
      • Get access point for user
      • Get All Forums
      • Get all groups
      • Get analytics data
      • Get Forum Posts
      • Get Forum Subscribers
      • Get Group Details
      • Get help request status
      • Get help requests for a tenant
      • Get list of access points
      • Get list of users connected to access points
      • Get Presence of User
      • Get presence of users belonging to a Department of a site
      • Get presence of users belonging to a site
      • Send Message
      • Subscribe to a Forum
      • Universal Search
      • Update Access point for a user
      • Update access points
      • Update Forum Post
      • Update Group Info
      • Update Group Targets
      • Upload CSV for Access Points
    • User Profile
      • Overview
      • assigns user_profile
      • creates user_profile
      • Deletes user_profile
      • Updates user_profile
      • View user_profile data
      • View All user_profile
    • SIP Trunk
      • Overview
      • Assign SipTrunk to SBC instance
      • Creates SIP trunk
      • Delete SipTrunk
      • Edit a SipTrunk
      • Get SipTrunk Status
      • View All SIP Trunk
  • Workcloud Sync Admin

    • Batch Services
      • Overview
      • Create a batch job instance
      • Creates and enqueues a batch job for asynchronous processing.
      • Deletes a specific job instance
      • Deletes a specific job instance
      • Get a batch job by its instance ID.
      • Returns a single job instance details object
      • Same functionality as Create Job but no body required, just uses the same file…
      • Should return a paginated list of job objects (using the infinite scroll fashion)
    • Client
      • Overview
      • ClientService_CreateQRCode
      • ClientService_CreateSCIMToken
      • ClientService_SearchClients
      • Creates a new client
      • Deactivates the SCIM token for a tenant without requiring the token itself
      • Deletes a client and everything related to it (all the tokens and the user).
      • Generates a new secret for the client.
      • Generates a token for a client and returns it
      • Generates a token for a client and returns it
      • Generates an OAuth2-compliant token for a client and returns it
      • Logout a token -- deletes it from Redis and Mongo
      • Return a list of clients
      • Returns all the info of a client.
      • Returns the status of the SCIM token for a tenant if it exists else, throws an…
      • Updates a client
    • License
      • Overview
      • Acknowledge License alert notification
      • Activate / Deactivate specified user licenses for specified app
      • createLicenseDetails
      • Get product families by license model
      • getAllLicenseDetails
      • getLicenseDetailsByProductFamily
      • License Notification Alert
      • List entitlements
      • List job executions
      • List License Update Failures
      • List products
      • Resend License activation welcome email
      • Run job execution
      • Summary
      • sync
      • Sync products
    • Property
      • Overview
      • Creates a property
      • Deletes a property value
      • Gets a property by key
      • Lists all properties
      • Responsible for doing advanced searching on property Example use case:…
      • Updates a property Only existing properties can be updated
    • Pub-Sub Connector
      • Overview
      • PubSubService_publish
      • PubSubService_subscribe
    • Scheduling
      • Overview
      • Can update everything except jobName and importType
      • Create the schedule request for job
      • Deletes the schedule - also should remove the job scheduler from the backend.
      • Gets an individual schedule
      • Lists all jobs under a specific tenant.
    • SCIM Mapping
      • Overview
      • Deletes the SCIM Mapping of a tenant.
      • Retrieves the SCIM Mapping of a tenant.
      • Upserts a SCIM Mapping for a tenant
    • Tenant
      • Overview
      • Create a new Tenant
      • Create a new tenant with your email as user creator and with that email as user…
      • Customer Self-service IDP - Base Setup https://confluence.zebra.com/display/ZRPS…
      • Customer Self-service IDP - Finalize Setup https://confluence.zebra.com/display/…
      • Delete a Tenant
      • Fields needed by UI for updating
      • Generates or regenerates an API key for a tenant.
      • Given an email, return the tenant that matches the email's domain by the tenant's emailDomain field
      • Handle License Service call to onboard a tenant
      • Onboard an existing tenant to MicroStrategy
      • Onboards all the tenants with no MicroStrategyDetails to MicroStragey
      • Return a list of all the deployed services, retrieved from a Worker Tenant.
      • Return a list of tenants.
      • Return one tenant by tenant id.
      • Returns the MicroStrategy details for a tenant
      • Search by multiple attributes
      • Send a PubSub message to Cloud Build to kickoff a deployment process
      • Update a Tenant
      • Upload the Customer IDP SAML metadata as a tenant attribute
      • Validates an API key and returns the associated tenant ID.
    • JIT Mapping
      • Overview
      • Deletes the JIT Mapping of a tenant.
      • Retrieves the JIT Mapping of a tenant.
      • Upserts a JIT Mapping for a tenant
    • Customer Partner Relationship
      • Overview
      • Creates a relationship
      • Deletes a relationship, either the unique ID or the customer/partner ID…
      • Return a list of relationships based on either the customer or partner, or all…
      • Returns one relationship based on either its unique ID or the customer/partner…
      • Update a relationship, either the unique ID or the customer/partner ID…
    • Token Verification
      • Overview
      • VerifyToken
    • User
      • Overview
      • Bulk create that creates all the valid users and return a list of errors.
      • Bulk update that updates all the users with valid update field values and…
      • Bulk Upload users with a given template
      • Creates a templated CSV download for users based on batchID
      • Creates a user under the tenant as tenant admin
      • Deletes a list of users of a tenant
      • Deletes a user from user_id and tenant
      • Get a User by a user_id and tenant_id
      • Get change log info by batch_id for templated bulk uploaded users
      • Get the number of users that are logged in by tenant or by subset of face value…
      • License all the users on the domains belonging to a specific tenant
      • List all the users (Paginated and w/ Filter)
      • List all the users by BatchId (Paginated)
      • List all the users by userId and tenantId
      • List all the users with multiple filters
      • Note: this is only used by Identity Service and will work only once.
      • Onboard user in Phoenix auth with RFID/FSS support
      • Retrieves the list of domains the logged in user has roles and permission to…
      • Retrieves the list of tenants the logged in user has permissions to access
      • Retrieving list of all valid departments for a given user
      • Returns the user's tenant and a link to the home operating set for that tenant
      • Returns users by permission ResourceType
      • Returns users related to permission and tenant (Does not return roles in…
      • Search a user using atlas Search, that allows for relevance scoring, which is a…
      • Search all the users (Paginated and w/ Filter)
      • Unlicense all the users on the domains belonging to a specific tenant
      • Update license of the user
      • Updates a user
      • Updates status for multiple users
      • Updates the status for a user
    • Access Point
      • Overview
      • Bulk update that updates all the accesspoints with valid update field values…
      • Create multiple accesspoints
      • Creates a CSV file download for accesspoints based on the batchID of the…
      • Creates a new accesspoint
      • Deletes a accesspoint by bssid and tenant
      • Deletes a list of accesspoints of a tenant
      • Get a Accesspoint by a bssid and tenant_id
      • Get change log info by batch_id for bulk CSV uploaded accesspoints
      • List all the accesspoints (Paginated and w/ Filter)
      • List CSV-uploaded accesspoints by the batchID of their upload (Paginated and w/…
      • Updates a accesspoint
      • Upload accesspoints via a CSV file.
    • Claim Mapping
      • Overview
      • Create a claim mapping
      • Delete a claim mapping
      • Return a list of claim mappings
      • Return one claim mapping
      • Update a claim mapping
    • Department
      • Overview
      • Add departments to a site department relation
      • Add roles to a department
      • Add users to a department.
      • Create a new Department
      • Delete one Department by name.
      • Get a Department by name.
      • List all departments.
      • List roles for the given department
      • List valid sites for a given department
      • Remove roles from a department
      • Remove users from a department
      • Return a list of limited departments
      • Update a department.
    • Invite User
      • Overview
      • Creates a generic invitation that a user can utilize to join the Platform
      • Deletes an invite token for the Phoenix platform.
      • Invites a list of users to the Phoenix platform
      • Lists all generic invites in a tenant
      • Retrieve an Invitation
    • Permission
      • Overview
      • Add users to a Permission
      • Bulk create that creates all the permissions and return a list of errors.
      • Deletes a permission
      • Remove users from a Permission
      • Returns a list of ownerTenantIds based on the permission resource type
      • Returns a list of permissions
      • Returns a list of permissions based on the provided list of claims
      • Returns a list of permissions of a user in a non-paginated response
      • Returns a list of unique values used in permission groups for a particular…
      • Returns all permissions of a tenant in a CSV format
      • Returns one permission by permission_id and tenant_id
      • Updates a permission
    • Role
      • Overview
      • Activates the dynamic role on the given user by the role_id that is…
      • Add permissions to a Role
      • Add roles to a Role
      • Add users to a Role
      • Add users to a Role
      • Create multiple roles
      • Deactivates the dynamic role on the given user by the role_id that is…
      • Delete a Role.
      • Deletes a list of roles of a tenant
      • Get the roles available to the user based on the primary site of the user.
      • Get User Roles
      • Internal use only Use case: Identity Service When a user authenticates,…
      • List Dynamic roles for an user
      • Remove permissions from a Role
      • Remove roles from a Role
      • Remove users to a Role
      • Remove users to a Role
      • Return a list of limited roles
      • Return a list of roles
      • Return one Role by tenant, domain and role id.
      • Search roles by multiple attributes and other filters
      • Update a Role.
    • Site
      • Overview
      • Add roles to a site
      • Add users to a site.
      • Bulk create Site-Department relationships.
      • Create a hierarchy metadata
      • Create a new site
      • Creates site_types or site_tiers based on the type = SITE_TYPE or SITE_TIER.
      • Delete a hierarchy metadata.
      • Delete one site by name.
      • Delete Site-Department relationship.
      • Deletes site_types or site_tiers based on the type = SITE_TYPE or SITE_TIER.
      • Fetch site_types or site_tiers based on the type = SITE_TYPE or SITE_TIER.
      • Fetch the hierarchy for the tenant (nested structure format for…
      • Get a site by name.
      • Get all of the available departments that can be added to a user given the site…
      • Get all of the available roles that can be added to a user given the site that…
      • List hierarchy metadata
      • List roles for the given site
      • List sites by tenant.
      • List valid departments for a given site Permission Level: Read Deprecated:…
      • Remove roles from a site
      • Returns whether the useHierarchyMetadata feature flag is enabled.
      • Search sites by text string across name, displayname, description, domain,…
      • Update a hierarchy metadata.
      • Update a site.
    • Site Template
      • Overview
      • Add a list of departments to a Site Template.
      • Add a list of roles to a Site Template.
      • Get all of the available departments that can be added to a user given a…
      • Get all of the available roles that can be added to a user given a…
      • SiteTemplateService_CreateSiteTemplate
      • SiteTemplateService_DeleteSiteTemplate
      • SiteTemplateService_GetSiteTemplate
      • SiteTemplateService_ListSiteTemplates
      • SiteTemplateService_SearchSiteTemplates
      • SiteTemplateService_UpdateSiteTemplate
    • Tenant Cleanup
      • Overview
      • TenantCleanupService_CleanupTenantData
    • User Mapping
      • Overview
      • Creates a new template for the bulk import of users in the CSV format
      • Deletes a template by name in a tenant
      • Downloads a CSV template that can be filled out and uploaded
      • For fetching template details with a particular tenant name in a tenant
      • Lists down all the template names in a tenant
      • Update an existing template by name in a tenant
    • Workspace
      • Overview
      • "Bulk" CSV download for workspaces The CSV format is the same as bulk upload
      • Add roles to a Workspace
      • Add to a Workspace by workspace type, name and tenant (all of them required)…
      • Add to a Workspace by workspace type, name and tenant (all of them required)…
      • Add users to a Workspace
      • Create multiple new Workspaces.
      • Delete from a Workspace by workspace type, name and tenant (all of them…
      • Delete list of Workspace by workspace type, name and tenant.
      • Delete one Workspace by workspace type, name and tenant, all of them required.
      • Expire (Set enabled scope to false) where the expiration date is today.
      • Get one Workspace by workspace type, name and tenant, all of them required
      • Get one Workspace by workspace type, name and tenant, all of them required.
      • Get Unique Workspace Types for a particular tenant.
      • List roles for the given workspace
      • List things inside a Workspace by workspace_type, name and tenant (all of them…
      • List workspaces by workspace type and tenant.
      • List workspaces matching the given "thing"
      • List workspaces with filters
      • Remove roles from a Workspace
      • Remove users from a Workspace
      • Search workspaces by text string across name, displayname, description, and attributes
      • The base64 encoded csv must have this format ->…
      • Update multiple Workspaces.
      • Update one Workspace by workspace type, name and tenant, all of them required.
    • Worker Tenant
      • Overview
      • Create a new Tenant
      • Customer Self-service IDP - Base Setup https://confluence.zebra.com/display/ZRPS…
      • Customer Self-service IDP - Finalize Setup https://confluence.zebra.com/display/…
      • Delete a Tenant
      • Fields needed by UI for updating
      • Generates or regenerates an API key for a tenant.
      • Given an email, return the tenant that matches the email's domain by the tenant's emailDomain field
      • Handle License Service call to onboard a tenant
      • Onboard an existing tenant to MicroStrategy
      • Onboards all the tenants with no MicroStrategyDetails to MicroStragey
      • Return a list of all the deployed services and its details.
      • Return a list of tenants.
      • Return one tenant by Entitlement-Tenant id.
      • Return one tenant by tenant id.
      • Returns the MicroStrategy details for a tenant
      • Update a Tenant
      • Upload the Customer IDP SAML metadata as a tenant attribute
      • Validates an API key and returns the associated tenant ID.
  • Workcloud Task Management

    • MyWork
      • Overview
      • Add a user note for a date
      • Dates that have saved user notes
      • Delete user note for a date
      • Get application-level configuration (modules, holidays, translations,…
      • Get private broadcast notes HTML content
      • Get user note for a date
      • List active broadcast messages for the user's domain
      • Update recently opened navigation tabs in the user session
      • Update user note for a date
    • Task Creator
      • Overview
      • Create Plan from XML
      • Create Project
      • Create Project from Template
      • Create Project from XML
      • Create Simple Project
      • Delete Project
      • Get Project Status
      • Get Project Type List
      • Get Template List
      • Get Template List with Tasks
      • Retrieve Project/Task Notes
      • Update Project Action
      • Upload Attachments
    • Task Execution
      • Overview
      • Add a new comment (with optional file attachments)
      • Add a note to a feed
      • All feeds for a project cluster (no pagination)
      • Available comment / message reason codes
      • Change feed/task status (multipart; file uploads supported)
      • Claim or unclaim a feed
      • Close a comment thread
      • Cluster reassignment (legacy handleFeedUpdate)
      • Comment list (full paginated or MSG two-phase load)
      • Delete a feed note
      • Feed action list — panels and button metadata
      • Feed audit thread / history (most recent first)
      • Feed HTML file-backed description content
      • Feed prerequisites / other attributes
      • Get merged MyWork configuration for requested types
      • Key attributes and extra attributes for a feed
      • Latest comments since last poll (incremental refresh)
      • List all notes on a feed
      • Mark all unread messages in a thread as read
      • Mark feed as favorite
      • Process predecessors CSV upload
      • Reassign feed (v1 path)
      • Reassign feed (v2 path — adjusted assignee/dept/profile defaults)
      • Record feed viewed / audit trail
      • Reply to an existing comment thread
      • Retrieve calendar / Gantt feed data (CALENDAR, STORE_PROJECTS, STORE_WALK_CAL)
      • Retrieve feeds — list, count, or list-latest (unified endpoint)
      • Retrieve leadership calendar project data (monthly or annual view)
      • Retrieve simple-type survey questions for a feed
      • Retrieve unread messages for the authenticated user
      • Status buttons for RTM
      • Submit survey answers and change feed status
      • Task-view feeds with cursor pagination (forces view_type=TV)
      • Transfer comment ownership between users
      • Unified feed details — one call, multiple section projections
      • Unmark feed as favorite
      • Unread message IDs and last-fetch timestamp
      • Update a feed note
      • Update extra project/task attributes
      • Update feed (status, acknowledge, thread effects)
      • Update monitor disposition
      • Update read/unread status for a single message
      • Update suggested start/end dates for a feed
      • Update task (v1 path)
      • Update task (v2 path)
      • Update watch flag and watch context
      • Updated single feed payload after an action
    • Walk Execution
      • Overview
      • Distribution store list for walk scheduling
      • Download questionnaire definition (with optional pre-populated answers)
      • Get walk detail by walk-id (form_unique_id)
      • List scheduled walks (with filtering, pagination, and sort)
      • List walk categories (optionally filtered by category_id)
      • List walk instances (with filtering, pagination, and sort)
      • List walk types available to the user (scoped by permit, schedule, and offline)
      • Schedule a walk for distribution to stores (multipart/form-data)
      • Start / create a new walk instance (multipart/form-data)
      • Submit questionnaire answers for a walk instance (multipart/form-data)
      • User list for walk assignment (scoped by profile, unit, department, org level)
      • Walk permissions for an entity
  • Extended Task Management

    • MyWork
      • Overview
      • Add a user note for a date
      • Dates that have saved user notes
      • Delete user note for a date
      • Get application-level configuration (modules, holidays, translations,…
      • Get private broadcast notes HTML content
      • Get user note for a date
      • List active broadcast messages for the user's domain
      • Update recently opened navigation tabs in the user session
      • Update user note for a date
    • Task Execution
      • Overview
      • Add a new comment (with optional file attachments)
      • Add a note to a feed
      • All feeds for a project cluster (no pagination)
      • Available comment / message reason codes
      • Change feed/task status (multipart; file uploads supported)
      • Claim or unclaim a feed
      • Close a comment thread
      • Cluster reassignment (legacy handleFeedUpdate)
      • Comment list (full paginated or MSG two-phase load)
      • Delete a feed note
      • Feed action list — panels and button metadata
      • Feed audit thread / history (most recent first)
      • Feed HTML file-backed description content
      • Feed prerequisites / other attributes
      • Get merged MyWork configuration for requested types
      • Key attributes and extra attributes for a feed
      • Latest comments since last poll (incremental refresh)
      • List all notes on a feed
      • Mark all unread messages in a thread as read
      • Mark feed as favorite
      • Process predecessors CSV upload
      • Reassign feed (v1 path)
      • Reassign feed (v2 path — adjusted assignee/dept/profile defaults)
      • Record feed viewed / audit trail
      • Reply to an existing comment thread
      • Retrieve calendar / Gantt feed data (CALENDAR, STORE_PROJECTS, STORE_WALK_CAL)
      • Retrieve feeds — list, count, or list-latest (unified endpoint)
      • Retrieve leadership calendar project data (monthly or annual view)
      • Retrieve simple-type survey questions for a feed
      • Retrieve unread messages for the authenticated user
      • Status buttons for RTM
      • Submit survey answers and change feed status
      • Task-view feeds with cursor pagination (forces view_type=TV)
      • Transfer comment ownership between users
      • Unified feed details — one call, multiple section projections
      • Unmark feed as favorite
      • Unread message IDs and last-fetch timestamp
      • Update a feed note
      • Update extra project/task attributes
      • Update feed (status, acknowledge, thread effects)
      • Update monitor disposition
      • Update read/unread status for a single message
      • Update suggested start/end dates for a feed
      • Update task (v1 path)
      • Update task (v2 path)
      • Update watch flag and watch context
      • Updated single feed payload after an action
    • Walk Execution
      • Overview
      • Distribution store list for walk scheduling
      • Download questionnaire definition (with optional pre-populated answers)
      • Get walk detail by walk-id (form_unique_id)
      • List scheduled walks (with filtering, pagination, and sort)
      • List walk categories (optionally filtered by category_id)
      • List walk instances (with filtering, pagination, and sort)
      • List walk types available to the user (scoped by permit, schedule, and offline)
      • Schedule a walk for distribution to stores (multipart/form-data)
      • Start / create a new walk instance (multipart/form-data)
      • Submit questionnaire answers for a walk instance (multipart/form-data)
      • User list for walk assignment (scoped by profile, unit, department, org level)
      • Walk permissions for an entity
  • Task Management Admin

    • Authentication
      • Overview
      • T-API login (external auth handler)
    • Kernel
      • Overview
      • Delete external users
      • Delete SCIM users
      • Departments / associations
      • Domain configuration — Import Domain JSON subset
      • Get details based on auth token
      • List external units
      • List external users
      • List SCIM users
      • Save external units
      • Save external users
      • Save SCIM users
      • Security profiles in domain (requires LIST^PROFILE)
      • Unit attributes with distinct values
      • Units by attribute values
      • Units list
      • User details from token
      • Users list

Workcloud Task Management

This overview is generated from the publication manifest and links to all APIs in this section.

APIs in this section

  • MyWork
  • Task Creator
  • Task Execution
  • Walk Execution