POST /rest/bpm/htm/v1/workBasket[?locale={string}]| 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.
|
The default content-type is application/json.
{ "description": "Work Basket Definition",
"type": "object",
"properties":
{
"customText1": {"type": "string", "optional": true,
"description": "The custom text specified as custom text one."
},
"customText2": {"type": "string", "optional": true,
"description": "The custom text specified as custom text two."
},
"customText3": {"type": "string", "optional": true,
"description": "The custom text specified as custom text three."
},
"customText4": {"type": "string", "optional": true,
"description": "The custom text specified as custom text four."
},
"customText5": {"type": "string", "optional": true,
"description": "The custom text specified as custom text five."
},
"customText6": {"type": "string", "optional": true,
"description": "The custom text specified as custom text six."
},
"customText7": {"type": "string", "optional": true,
"description": "The custom text specified as custom text seven."
},
"customText8": {"type": "string", "optional": true,
"description": "The custom text specified as custom text eight."
},
"defaultQueryTable": {"type": "string", "optional": true,
"description": "Default Query Table for work baskets."
},
"description": {"type": "string", "optional": true,
"description": "Description of the work basket."
},
"displayName": {"type": "string", "optional": true,
"description": "Display name of the work basket."
},
"distributionTargets": {"type": ["string"], "optional": true,
"description": "List of IDs of work baskets that are distribution targets."
},
"jndiNameOfStaffPluginProvider": {"type": "string", "optional": true,
"description": "JNDI name of a user-defined people directory configuration. Needs to be provided only if peopleAssignments are used and no global default has been set."
},
"name": {"type": "string",
"description": "The name of the work basket."
},
"owner": {"type": "string", "optional": true,
"description": "Owner of the work basket."
},
"peopleAssignment": {"type":
[
{ "assignmentReason": {"type": "string",
"description": "The reason for the assignment.",
"enum":
[
"REASON_APPENDER",
"REASON_CUSTOMROLE_1",
"REASON_CUSTOMROLE_2",
"REASON_CUSTOMROLE_3",
"REASON_CUSTOMROLE_4",
"REASON_CUSTOMROLE_5",
"REASON_CUSTOMROLE_6",
"REASON_CUSTOMROLE_7",
"REASON_CUSTOMROLE_8",
"REASON_CUSTOMROLE_9",
"REASON_CUSTOMROLE_10",
"REASON_CUSTOMROLE_11",
"REASON_CUSTOMROLE_12",
"REASON_CUSTOMROLE_13",
"REASON_CUSTOMROLE_14",
"REASON_CUSTOMROLE_15",
"REASON_CUSTOMROLE_16",
"REASON_CUSTOMROLE_17",
"REASON_CUSTOMROLE_18",
"REASON_CUSTOMROLE_19",
"REASON_CUSTOMROLE_20",
"REASON_DISTRIBUTOR",
"REASON_INHERITANCE_ADMINISTRATOR",
"REASON_INHERITANCE_EDITOR",
"REASON_INHERITANCE_POTENTIAL_OWNER",
"REASON_INHERITANCE_READER",
"REASON_OPENER",
"REASON_READER",
"REASON_TRANSFER_INITIATOR"
]
},
"assignmentType": {"type": "string",
"description": "Type of the people assignment.",
"enum":
[
"TYPE_GROUP_MEMBERS_AND_USERS",
"TYPE_ORGANIZATIONAL_ENTITY",
"TYPE_EVERYBODY"
]
},
"users": {"type": ["string"], "optional": true,
"description": "List of assigned users."
},
"groups": {"type": ["string"], "optional": true,
"description": "List of assigned groups."
}
}
], "optional": true
},
"substitutionPolicy": {"type": "string", "optional": true,
"description": "The substitution policy that takes place when people assignments are performed. SUBSTITUTION_POLICY_NO_SUBSTITUTION is the default.",
"enum":
[
"SUBSTITUTION_POLICY_NO_SUBSTITUTION",
"SUBSTITUTION_POLICY_SUBSTITUTE_IF_ABSENT",
"SUBSTITUTION_POLICY_SELECT_USER_IF_PRESENT"
]
},
"type": {"type": "string", "optional": true,
"description": "The type of the work basket. TYPE_GROUP is the default.",
"enum":
[
"TYPE_GROUP",
"TYPE_TOPIC",
"TYPE_INDIVIDUAL",
"TYPE_CLEARANCE"
]
}
}
}
The default content-type is application/json.
{ "description": "Work Basket",
"type": "object",
"properties":
{
"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."
}
}
}
The default content-type is application/json.
{ "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."
}
}
}
| 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. |
| 406 Not Acceptable | The requested content type or content encoding is not supported. |
| 415 Unsupported Media Type | The content type or content encoding of the request is not supported. |
| 500 Internal Server Error | A severe problem has occurred. Programmer's details are provided. |
7.0 Feature Pack
Parent topic: Work Basket Resource