---
  host: "localhost"
  basePath: "/wcs/resources"
  schemes: 
    - "https"
  swagger: "2.0"
  info: 
    version: "WC.TOOLKIT Enterprise Version : 9 Fix Pack : 0"
    title: "WebSphere Commerce V9 - Workspace Support API"
    description: "These services provide APIs related to workspaces in a B2B or B2C store. Use these classes to: Get task group details, Get task details, Get workspace details."
  tags: 
    - 
      name: "task_group"
      description: "This class provides RESTful services to get task group details. It uses the Task Group noun. Meant for use in authoring server only."
    - 
      name: "task"
      description: "This class provides RESTful services to get task details. It uses the Task noun. Meant for use in authoring server only."
    - 
      name: "workspace"
      description: "This class provides RESTful services to get workspace details. It uses the Workspace noun. Meant for use in authoring server only."
  paths: 
    /store/{storeId}/task_group/createTaskGroup: 
      post: 
        responses: 
          200: 
            description: "No response was specified"
            schema: 
              $ref: "#/definitions/com.ibm.commerce.tools.contentmanagement.commands.TaskgroupCreateControllerCmd"
          201: 
            description: "The requested resource has been created."
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The workspace identifier."
            in: "query"
            name: "workspaceId"
          - 
            required: true
            type: "string"
            description: "The name of the task group."
            in: "query"
            name: "name"
          - 
            required: false
            type: "string"
            description: "The description of the task group."
            in: "query"
            name: "description"
          - 
            enum: 
              - "true"
            name: "quickPublish"
            required: false
            in: "query"
            type: "string"
            description: "Whether to quick publish task group."
          - 
            enum: 
              - "true"
            name: "persistent"
            required: false
            in: "query"
            type: "string"
            description: "Whether task group is persistent."
          - 
            required: false
            type: "string"
            description: "Date and time the task group is due. Format: yyyy-MM-dd HH:mm:ss."
            in: "query"
            name: "dueDate"
          - 
            required: false
            type: "string"
            description: "Date and time to commit task group. Format: yyyy-MM-dd HH:mm:ss."
            in: "query"
            name: "promotionDate"
          - 
            required: false
            type: "string"
            description: "The list of approvers for the task group. Separate multiple approvers with a comma. Ex: -1000,2,55."
            in: "query"
            name: "approvers"
          - 
            enum: 
              - "xml"
              - "json"
            name: "responseFormat"
            required: false
            in: "query"
            type: "string"
            description: "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json."
        tags: 
          - "task_group"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Create a task group."
        operationId: "createTaskGroup"
    /store/{storeId}/task_group/changeStatus: 
      put: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/com.ibm.commerce.tools.contentmanagement.commands.TaskgroupChangeStatusControllerCmd"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The task group identifier."
            in: "query"
            name: "taskgroupId"
          - 
            enum: 
              - "ACTION_APPROVE"
              - "ACTION_ACTIVATE"
              - "ACTION_RETURN_TO_ACTIVE"
              - "ACTION_CANCEL"
              - "ACTION_REJECT"
            name: "actionType"
            required: true
            in: "query"
            type: "string"
            description: "The change status action to perform on task group."
          - 
            enum: 
              - "xml"
              - "json"
            name: "responseFormat"
            required: false
            in: "query"
            type: "string"
            description: "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json."
        tags: 
          - "task_group"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Change task group status by performing an action on it."
        operationId: "changeStatus"
    /store/{storeId}/task/createTask: 
      post: 
        responses: 
          200: 
            description: "No response was specified"
            schema: 
              $ref: "#/definitions/com.ibm.commerce.tools.contentmanagement.commands.TaskCreateControllerCmd"
          201: 
            description: "The requested resource has been created."
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The task group identifier."
            in: "query"
            name: "taskgroupId"
          - 
            required: true
            type: "string"
            description: "The name of the task."
            in: "query"
            name: "name"
          - 
            required: false
            type: "string"
            description: "The description of the task."
            in: "query"
            name: "description"
          - 
            required: false
            type: "string"
            description: "Date and time the task group is due. Format: yyyy-MM-dd HH:mm:ss."
            in: "query"
            name: "dueDate"
          - 
            required: false
            type: "string"
            description: "The list of contributors for the task. Separate multiple with a comma. Ex: -1000,2,55."
            in: "query"
            name: "contributors"
          - 
            enum: 
              - "xml"
              - "json"
            name: "responseFormat"
            required: false
            in: "query"
            type: "string"
            description: "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json."
        tags: 
          - "task"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Create a task."
        operationId: "createTask"
    /store/{storeId}/workspace/updateWorkspace: 
      put: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/com.ibm.commerce.tools.contentmanagement.commands.WorkspaceUpdateControllerCmd"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The workspace identifier."
            in: "query"
            name: "workspaceId"
          - 
            required: false
            type: "string"
            description: "The name of the workspace."
            in: "query"
            name: "name"
          - 
            required: false
            type: "string"
            description: "The description of the workspace."
            in: "query"
            name: "description"
          - 
            enum: 
              - "true"
              - "false"
            name: "persistent"
            required: false
            in: "query"
            type: "string"
            description: "Whether the workspace is persistent"
          - 
            enum: 
              - "true"
              - "false"
            name: "emergencyFix"
            required: false
            in: "query"
            type: "string"
            description: "Whether the workspace is an emergency fix."
          - 
            enum: 
              - "xml"
              - "json"
            name: "responseFormat"
            required: false
            in: "query"
            type: "string"
            description: "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json."
        tags: 
          - "workspace"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Update a workspace."
        operationId: "updateWorkspace"
    /store/{storeId}/workspace/createWorkspace: 
      post: 
        responses: 
          200: 
            description: "No response was specified"
            schema: 
              $ref: "#/definitions/com.ibm.commerce.tools.contentmanagement.commands.WorkspaceCreateControllerCmd"
          201: 
            description: "The requested resource has been created."
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The name of the workspace."
            in: "query"
            name: "name"
          - 
            required: false
            type: "string"
            description: "The description of the workspace."
            in: "query"
            name: "description"
          - 
            enum: 
              - "true"
            name: "persistent"
            required: false
            in: "query"
            type: "string"
            description: "Whether the workspace is persistent"
          - 
            enum: 
              - "true"
            name: "emergencyFix"
            required: false
            in: "query"
            type: "string"
            description: "Whether the workspace is an emergency fix."
          - 
            enum: 
              - "xml"
              - "json"
            name: "responseFormat"
            required: false
            in: "query"
            type: "string"
            description: "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json."
        tags: 
          - "workspace"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Create a worskpace."
        operationId: "createWorkspace"
    /store/{storeId}/task/taskId/{taskId}: 
      get: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/task-IBM_Admin_All"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The task identifier."
            in: "path"
            name: "taskId"
          - 
            enum: 
              - "IBM_Admin_All"
            name: "profileName"
            required: false
            in: "query"
            type: "string"
            description: "Profile name. Profiles determine the subset of data to be returned by a query."
          - 
            description: "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work."
            format: "int64"
            required: false
            in: "query"
            type: "integer"
            name: "pageNumber"
          - 
            description: "Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The \"pageNumber\" must be specified for paging to work."
            format: "int64"
            required: false
            in: "query"
            type: "integer"
            name: "pageSize"
        tags: 
          - "task"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Finds a task by its ID."
        operationId: "findByTaskId"
    /store/{storeId}/workspace/changeStatus: 
      put: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/com.ibm.commerce.tools.contentmanagement.commands.WorkspaceChangeStatusControllerCmd"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The workspace identifier."
            in: "query"
            name: "workspaceId"
          - 
            enum: 
              - "ACTION_CANCEL_WORKSPACE"
            name: "actionType"
            required: true
            in: "query"
            type: "string"
            description: "The change status action to perform on workspace."
          - 
            enum: 
              - "xml"
              - "json"
            name: "responseFormat"
            required: false
            in: "query"
            type: "string"
            description: "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json."
        tags: 
          - "workspace"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Change workspace status by performing an action on it."
        operationId: "changeStatus"
    /store/{storeId}/task_group/updateTaskGroup: 
      put: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/com.ibm.commerce.tools.contentmanagement.commands.TaskgroupUpdateControllerCmd"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The task group identifier."
            in: "query"
            name: "taskgroupId"
          - 
            required: false
            type: "string"
            description: "The name of the task group."
            in: "query"
            name: "name"
          - 
            required: false
            type: "string"
            description: "The description of the task group."
            in: "query"
            name: "description"
          - 
            enum: 
              - "true"
              - "false"
            name: "quickPublish"
            required: false
            in: "query"
            type: "string"
            description: "Whether to quick publish task group."
          - 
            enum: 
              - "true"
              - "false"
            name: "persistent"
            required: false
            in: "query"
            type: "string"
            description: "Whether task group is persistent."
          - 
            required: false
            type: "string"
            description: "Date and time the task group is due. Format: yyyy-MM-dd HH:mm:ss."
            in: "query"
            name: "dueDate"
          - 
            required: false
            type: "string"
            description: "Date and time to commit task group. Format: yyyy-MM-dd HH:mm:ss."
            in: "query"
            name: "promotionDate"
          - 
            required: false
            type: "string"
            description: "The list of approvers for the task group. Separate multiple approvers with a comma. Ex: -1000,2,55."
            in: "query"
            name: "approvers"
          - 
            enum: 
              - "xml"
              - "json"
            name: "responseFormat"
            required: false
            in: "query"
            type: "string"
            description: "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json."
        tags: 
          - "task_group"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Update a task group."
        operationId: "updateTaskGroup"
    /store/{storeId}/task_group/createTaskGroupComment: 
      post: 
        responses: 
          200: 
            description: "No response was specified"
            schema: 
              $ref: "#/definitions/com.ibm.commerce.tools.contentmanagement.commands.TaskgroupUpdateCommentsControllerCmd"
          201: 
            description: "The requested resource has been created."
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The task group identifier."
            in: "query"
            name: "taskgroupId"
          - 
            required: true
            type: "string"
            description: "The task group comment."
            in: "query"
            name: "comment"
          - 
            enum: 
              - "xml"
              - "json"
            name: "responseFormat"
            required: false
            in: "query"
            type: "string"
            description: "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json."
        tags: 
          - "task_group"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Create a task group comment."
        operationId: "createTaskGroupComment"
    /store/{storeId}/task_group/taskGroupId/{taskGroupId}: 
      get: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/task_group-IBM_Admin_All"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The task group identifier."
            in: "path"
            name: "taskGroupId"
          - 
            enum: 
              - "IBM_Admin_All"
              - "IBM_Admin_TaskGroupChangeHistories"
            name: "profileName"
            required: false
            in: "query"
            type: "string"
            description: "Profile name. Profiles determine the subset of data to be returned by a query."
          - 
            description: "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work."
            format: "int64"
            required: false
            in: "query"
            type: "integer"
            name: "pageNumber"
          - 
            description: "Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The \"pageNumber\" must be specified for paging to work."
            format: "int64"
            required: false
            in: "query"
            type: "integer"
            name: "pageSize"
        tags: 
          - "task_group"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Finds a task group by its ID."
        operationId: "findByTaskGroupId"
    /store/{storeId}/task: 
      get: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/Empty"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            enum: 
              - "byTaskGroupId"
              - "byStatus"
            name: "q"
            required: true
            in: "query"
            type: "string"
            description: "The query name."
        tags: 
          - "task"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Finds tasks by a query. See each query for details on input and output."
        operationId: "findByQuery"
    /store/{storeId}/workspace: 
      get: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/Empty"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            enum: 
              - "byStatus"
            name: "q"
            required: true
            in: "query"
            type: "string"
            description: "The query name."
        tags: 
          - "workspace"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Finds workspaces by a query. See each query for details on input and output."
        operationId: "findByQuery"
    /store/{storeId}/workspace/workspaceId/{workspaceId}: 
      get: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/workspace-IBM_Admin_All"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The workspace identifier."
            in: "path"
            name: "workspaceId"
          - 
            enum: 
              - "IBM_Admin_All"
            name: "profileName"
            required: false
            in: "query"
            type: "string"
            description: "Profile name. Profiles determine the subset of data to be returned by a query."
          - 
            description: "Page number, starting at 1. Valid values include positive integers of 1 and above. The \"pageSize\" must be specified for paging to work."
            format: "int64"
            required: false
            in: "query"
            type: "integer"
            name: "pageNumber"
          - 
            description: "Page size. Used to limit the amount of data returned by a query. Valid values include positive integers of 1 and above. The \"pageNumber\" must be specified for paging to work."
            format: "int64"
            required: false
            in: "query"
            type: "integer"
            name: "pageSize"
        tags: 
          - "workspace"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Finds a workspace by its ID."
        operationId: "findByWorkspaceId"
    /store/{storeId}/task/changeStatus: 
      put: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/com.ibm.commerce.tools.contentmanagement.commands.TaskChangeStatusControllerCmd"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The task identifier."
            in: "query"
            name: "taskId"
          - 
            required: true
            type: "string"
            description: "The task group identifier."
            in: "query"
            name: "taskGroupId"
          - 
            enum: 
              - "ACTION_COMPLETE"
              - "ACTION_RETURN_TO_WORKING"
              - "ACTION_REJECT"
            name: "actionType"
            required: true
            in: "query"
            type: "string"
            description: "The change status action to perform on task."
          - 
            enum: 
              - "xml"
              - "json"
            name: "responseFormat"
            required: false
            in: "query"
            type: "string"
            description: "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json."
        tags: 
          - "task"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Change task status by performing an action on it."
        operationId: "changeStatus"
    /store/{storeId}/task_group: 
      get: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/Empty"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            enum: 
              - "byWorkspaceId"
            name: "q"
            required: true
            in: "query"
            type: "string"
            description: "The query name."
        tags: 
          - "task_group"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Finds task groups by a query. See each query for details on input and output."
        operationId: "findByQuery"
    /store/{storeId}/task/updateTask: 
      put: 
        responses: 
          200: 
            description: "The requested completed successfully."
            schema: 
              $ref: "#/definitions/com.ibm.commerce.tools.contentmanagement.commands.TaskUpdateControllerCmd"
          400: 
            description: "Bad request. Some of the inputs provided to the request aren't valid."
          401: 
            description: "Not authenticated. The user session isn't valid."
          403: 
            description: "The user isn't authorized to perform the specified request."
          500: 
            description: "Internal server error. Additional details will be contained on the server logs."
        parameters: 
          - 
            enum: 
              - "0"
              - "10001"
              - "10501"
              - "11001"
              - "1"
              - "11501"
              - "2"
            name: "storeId"
            required: true
            in: "path"
            type: "string"
            description: "The store identifier."
          - 
            required: true
            type: "string"
            description: "The task identifier."
            in: "query"
            name: "taskId"
          - 
            required: false
            type: "string"
            description: "The name of the task."
            in: "query"
            name: "name"
          - 
            required: false
            type: "string"
            description: "The description of the task."
            in: "query"
            name: "description"
          - 
            required: false
            type: "string"
            description: "Date and time the task group is due. Format: yyyy-MM-dd HH:mm:ss."
            in: "query"
            name: "dueDate"
          - 
            required: false
            type: "string"
            description: "The list of contributors for the task. Separate multiple with a comma. Ex: -1000,2,55."
            in: "query"
            name: "contributors"
          - 
            enum: 
              - "xml"
              - "json"
            name: "responseFormat"
            required: false
            in: "query"
            type: "string"
            description: "The response format. If the request has an input body, that body must also use the format specified in \"responseFormat\". Valid values include \"json\" and \"xml\" without the quotes. If the responseFormat isn't specified, the \"accept\" HTTP header shall be used to determine the format of the response. If the \"accept\" HTTP header isn't specified as well, the default response format shall be in json."
        tags: 
          - "task"
        produces: 
          - "application/json"
          - "application/xml"
          - "application/xhtml+xml"
          - "application/atom+xml"
        summary: "Update a task."
        operationId: "updateTask"
  definitions: 
    task_group-IBM_Admin_All_item.TaskGroupComments.userDataField: 
      required: 
        - "key"
      properties: 
        value: 
          type: "string"
        key: 
          type: "string"
    task_group-IBM_Admin_All_item.TaskGroupApprovers: 
      properties: 
        approverLogonID: 
          type: "string"
        userDataField: 
          items: 
            $ref: "#/definitions/task_group-IBM_Admin_All_item.TaskGroupApprovers.userDataField"
          type: "array"
        approverID: 
          type: "string"
    com.ibm.commerce.tools.contentmanagement.commands.TaskgroupCreateControllerCmd: {}
    task_group-IBM_Admin_All_item.TaskGroupComments: 
      properties: 
        comment: 
          type: "string"
        postDate: 
          type: "string"
        userDataField: 
          items: 
            $ref: "#/definitions/task_group-IBM_Admin_All_item.TaskGroupComments.userDataField"
          type: "array"
        posterLogonID: 
          type: "string"
    com.ibm.commerce.tools.contentmanagement.commands.TaskCreateControllerCmd: {}
    com.ibm.commerce.tools.contentmanagement.commands.TaskgroupUpdateControllerCmd: {}
    task_group-IBM_Admin_All_item: 
      properties: 
        status: 
          type: "string"
        approvalDate: 
          type: "string"
        parentWorkspaceManagerID: 
          type: "string"
        taskGroupID: 
          type: "string"
        taskGroupName: 
          type: "string"
        quickPublish: 
          type: "boolean"
        parentWorkspaceID: 
          type: "string"
        parentWorkspaceExternalIdentifier: 
          type: "string"
        promotionDate: 
          type: "string"
        commitDate: 
          type: "string"
        taskGroupDescription: 
          type: "string"
        recurring: 
          type: "boolean"
        parentWorkspaceName: 
          type: "string"
        userDataField: 
          items: 
            $ref: "#/definitions/task_group-IBM_Admin_All_item.userDataField"
          type: "array"
        TaskGroupComments: 
          items: 
            $ref: "#/definitions/task_group-IBM_Admin_All_item.TaskGroupComments"
          type: "array"
        TaskGroupApprovers: 
          items: 
            $ref: "#/definitions/task_group-IBM_Admin_All_item.TaskGroupApprovers"
          type: "array"
        dueDate: 
          type: "string"
        taskGroupExternalIdentifier: 
          type: "string"
    com.ibm.commerce.tools.contentmanagement.commands.TaskgroupChangeStatusControllerCmd: {}
    com.ibm.commerce.tools.contentmanagement.commands.TaskChangeStatusControllerCmd: {}
    Empty: 
      description: "Empty model. Used as default value when no model is specified."
    task_group-IBM_Admin_All_item.userDataField: 
      required: 
        - "key"
      properties: 
        value: 
          type: "string"
        key: 
          type: "string"
    workspace-IBM_Admin_All: 
      properties: 
        recordSetCount: 
          type: "integer"
          format: "int64"
        recordSetComplete: 
          type: "boolean"
        recordSetStartNumber: 
          type: "integer"
          format: "int64"
        resultList: 
          items: 
            $ref: "#/definitions/workspace-IBM_Admin_All_item"
          type: "array"
        recordSetTotal: 
          type: "integer"
          format: "int64"
    workspace-IBM_Admin_All_item: 
      properties: 
        status: 
          type: "string"
        workspaceName: 
          type: "string"
        persistent: 
          type: "boolean"
        workspaceExternalIdentifier: 
          type: "string"
        workspaceID: 
          type: "string"
        emergencyUse: 
          type: "boolean"
        userDataField: 
          items: 
            $ref: "#/definitions/workspace-IBM_Admin_All_item.userDataField"
          type: "array"
        workspaceDescription: 
          type: "string"
    task_group-IBM_Admin_All: 
      properties: 
        recordSetCount: 
          type: "integer"
          format: "int64"
        recordSetComplete: 
          type: "boolean"
        recordSetStartNumber: 
          type: "integer"
          format: "int64"
        resultList: 
          items: 
            $ref: "#/definitions/task_group-IBM_Admin_All_item"
          type: "array"
        recordSetTotal: 
          type: "integer"
          format: "int64"
    workspace-IBM_Admin_All_item.userDataField: 
      required: 
        - "key"
      properties: 
        value: 
          type: "string"
        key: 
          type: "string"
    com.ibm.commerce.tools.contentmanagement.commands.TaskgroupUpdateCommentsControllerCmd: {}
    task-IBM_Admin_All_item.TaskMembers: 
      properties: 
        memberName: 
          type: "string"
        userDataField: 
          items: 
            $ref: "#/definitions/task-IBM_Admin_All_item.TaskMembers.userDataField"
          type: "array"
        memberID: 
          type: "string"
    task-IBM_Admin_All: 
      properties: 
        recordSetCount: 
          type: "integer"
          format: "int64"
        recordSetComplete: 
          type: "boolean"
        recordSetStartNumber: 
          type: "integer"
          format: "int64"
        resultList: 
          items: 
            $ref: "#/definitions/task-IBM_Admin_All_item"
          type: "array"
        recordSetTotal: 
          type: "integer"
          format: "int64"
    com.ibm.commerce.tools.contentmanagement.commands.TaskUpdateControllerCmd: {}
    task-IBM_Admin_All_item.TaskMembers.userDataField: 
      required: 
        - "key"
      properties: 
        value: 
          type: "string"
        key: 
          type: "string"
    com.ibm.commerce.tools.contentmanagement.commands.WorkspaceChangeStatusControllerCmd: {}
    task-IBM_Admin_All_item: 
      properties: 
        completionDate: 
          type: "string"
        approvalDate: 
          type: "string"
        taskName: 
          type: "string"
        parentTaskGroupExternalIdentifier: 
          type: "string"
        parentWorkspaceID: 
          type: "string"
        parentWorkspaceExternalIdentifier: 
          type: "string"
        taskDescription: 
          type: "string"
        promotionDate: 
          type: "string"
        commitDate: 
          type: "string"
        status: 
          type: "string"
        taskExternalIdentifier: 
          type: "string"
        taskId: 
          type: "string"
        userDataField: 
          items: 
            $ref: "#/definitions/task-IBM_Admin_All_item.userDataField"
          type: "array"
        usage: 
          type: "string"
        parentWorkspaceName: 
          type: "string"
        parentTaskGroupID: 
          type: "string"
        TaskMembers: 
          items: 
            $ref: "#/definitions/task-IBM_Admin_All_item.TaskMembers"
          type: "array"
        dueDate: 
          type: "string"
        parentTaskGroupName: 
          type: "string"
    com.ibm.commerce.tools.contentmanagement.commands.WorkspaceCreateControllerCmd: {}
    task-IBM_Admin_All_item.userDataField: 
      required: 
        - "key"
      properties: 
        value: 
          type: "string"
        key: 
          type: "string"
    com.ibm.commerce.tools.contentmanagement.commands.WorkspaceUpdateControllerCmd: {}
    task_group-IBM_Admin_All_item.TaskGroupApprovers.userDataField: 
      required: 
        - "key"
      properties: 
        value: 
          type: "string"
        key: 
          type: "string"

