REST Interface for BPEL-related Task Resources - Work Basket Distribution Targets Resource - GET Method

Use this method to retrieve the distribution targets of a specified work basket.

Sample method invocation

GET /rest/bpm/htm/v1/workBasket/{wbid}/distributionTargets[?locale={string}]

Parameters

Optional Parameters

Name	Value Type	Description
locale	string	Locale for description and displayName. Valid values are either standard language, country and variant specifications (for example `"en"`, `"en-US"`, `"en-US-WIN"`) or the constant `"default"`. If this parameter is omitted then the setting from the HTTP request header is used.

Request Content

None

Response Content

Work basket distribution targets.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Work Basket Distribution Targets", 
   "type": "object",
   "properties":
   {  
      "wbid": {"type": "string",
         "description": "Work basket ID."
      },
      "name": {"type": "string",
         "description": "The name of the work basket."
      },
      "identifier": {"type": "string"},
      "distributionTargets":
       [
         {
           "creationTime":  {"type": "string", "format": "date-time",
              "description": "Time when the work basket has been created."
           },
           "customText1": {"type": "string", 
              "description": "The custom text specified as custom text one."
           },
           "customText2": {"type": "string", 
              "description": "The custom text specified as custom text two."
           },
           "customText3": {"type": "string", 
              "description": "The custom text specified as custom text three."
           },
           "customText4": {"type": "string", 
              "description": "The custom text specified as custom text four."
           },
           "customText5": {"type": "string", 
              "description": "The custom text specified as custom text five."
           },
           "customText6": {"type": "string", 
              "description": "The custom text specified as custom text six."
           },
           "customText7": {"type": "string", 
              "description": "The custom text specified as custom text seven."
           },
           "customText8": {"type": "string", 
              "description": "The custom text specified as custom text eight."
           },
           "defaultQueryTable": {"type": "string",
              "description": "Default Query Table for work baskets."
           },
           "description": {"type": "string",
              "description": "Description of the work basket."
           },
           "displayName": {"type": "string",
              "description": "Display name of the work basket."
           },
           "distributionTargets": {"type": ["string"], "optional": true,
              "description": "List of distribution targets."
           },
           "jndiNameOfStaffPluginProvider": {"type": "string",
              "description": "JNDI name of a user-defined people directory configuration."
           },
           "lastModificationTime":  {"type": "string", "format": "date-time",
              "description": "Last time a property of the work basket has been changed."
           },
           "name": {"type": "string",
              "description": "The name of the work basket."
           },
           "owner": {"type": "string",
              "description": "Owner of the work basket."
           },
           "substitutionPolicy": {"type": "string", 
              "description": "The substitution policy that takes place when people assignments are performed.",
              "enum":
              [
                 "SUBSTITUTION_POLICY_NO_SUBSTITUTION",
                 "SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT",
                 "SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT"
              ]
           },
           "type": {"type": "string", 
              "description": "The type of the work basket.",
              "enum":
              [
                 "TYPE_GROUP",
                 "TYPE_TOPIC",
                 "TYPE_INDIVIDUAL",
                 "TYPE_CLEARANCE"
              ]
           },
           "wbid": {"type": "string",
              "description": "Work basket ID."
           }
         }
       ]
   }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

Schema

{  "description": "Error Response", 
   "type": "object",
   "properties":
   {  "errorNumber": {"type": "string",
         "description": "Message ID of the exception."
      },
      "errorMessage": {"type": "string",
         "description": "Message text of the exception."
      },
      "errorMessageParameters": {"type": ["string"], "optional": true,
         "description":"Message text parameters of the exception."
      },
      "programmersDetails": {"type": "object", "optional": true,
         "description":"Additional, exception details, for example, a stack trace."
      }
   }
}

Status codes

The method returns one of the following status codes:

Code	Description
200 OK	Success completion.
400 Bad Request	The parameters are not valid or they are missing.
401 Unauthorized	The caller is not authorized for this request.
404 Not Found	The work basket does not exist.
406 Not Acceptable	The requested content type or content encoding is not supported.
500 Internal Server Error	A severe problem has occurred. Programmer's details are provided.

Available since

7.0 Feature Pack

Parent topic: Work Basket Distribution Targets Resource