WorkRequests.getList (Method)
Returns zero or more structures, each containing information on a work request; for example, 'ApplyToPage', 'AssignedTo', 'Creator', and so on. It also returns information of a request/s urgency.
Returns:
WorkRequests_GetList_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| ApplyToPage | Boolean | Boolean flag which when set to true indicates that the work request applies to a specific page. 0 indicates that this is a general work request. |
| AssignedTo | Person_FirstNameMiddleNameLastName | The 'firstname middlename last name' of the user assigned to a work request. |
| AssignedToID | UserGroupID_ExcludingAnonAuth | The ID of the user or group assigned to a work request. This cannot be the ID of an anonymous or authenticated user. |
| Creator | Person_FirstNameMiddleNameLastName | The 'firstname middlename last name' of the user who created a work request. |
| CreatorID | UserID | The ID of the user who created a work request. |
| DeleteOnCompletion | Boolean | Boolean flag which when set to true indicates that CommonSpot should delete the work request after the request is completed. |
| DueDate | Date | The date when the work request should be completed. |
| IconPath | ServerRelativeURL_EmptyString | A server-relative URL to the icon representing the page or document's type. |
| IconText | PlainText | Text describing the page or document's type, an empty string if a general work request. |
| ID | WorkRequestID | The work request's ID. |
| isAccepted | Boolean | Boolean flag which when set to true means the work request has been accepted. |
| isCompleted | Boolean | Boolean flag which when set to true means the work request has been completed. |
| IsCreator | Boolean | Boolean flag which when set to true indicates the current user created the work request. |
| isPastDue | Boolean | Boolean flag which when set to true indicates that the work request is past due. |
| isUploadedDoc | Boolean | Boolean flag which when set to true indicates that the item is an uploaded document. |
| Notes | PlainText | Notes describing the work request. |
| notifyOnAccept | Boolean | Boolean flag which when set to true tells CommonSpot to send out notifications that the work request was accepted. |
| notifyOnAssignment | Boolean | Boolean flag which when set to true tells CommonSpot to send out notifications that the work request was assigned. |
| notifyOnCompletion | Boolean | Boolean flag which when set to true tells CommonSpot to send out notifications that the work request is completed. |
| notifyOnReject | Boolean | Boolean flag which when set to true tells CommonSpot to send out notifications that the work request was rejected. |
| PageID | PageID_0 | The ID of the page the work request is associated with. If this value is 0, this is a general work request. |
| PageTitle | PlainText | The title of the page associated with the work request. An empty string indicates that the associated request is a general work request. |
| PageType | PageType_EmptyString | The type of the page or object to which workrequest is; for example, 0 (normal or uploaded document), 1 (template), 4 (custom element), or 6 (page set). An empty string indicates that the associated request is a general work request. |
| PageURL | ServerRelativeURL_EmptyString | The URL of the page which the work request is associated. An empty string indicates that the associated request is a general work request. |
| RejectDate | DateTime_EmptyString | The date the work request was rejected, or an empty string. |
| RejectNotes | PlainText_255 | Notes why the work request was rejected. |
| RejectorID | UserID_0 | The ID of the person who rejected the work request, or 0 if not rejected. |
| Title | PlainText_NonNull | The work request's title. |
| Urgency | Urgency | The urgency of the work request, as follows: 0 (high), 1 (medium), or 2 (low). |
| UrgencyString | PlainText | The urgency of the work request, as follows: 0 (high), 1 (medium), or 2 (low). |
| WorkType | PlainText_NonNull_100 | The work request resource type's name. |
| WorkTypeID | WorkRequestResourceID | The work request's resource type ID. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| objectID | PageID_0_NEG1 | Required | A page's ID. If this value is 0, CommonSpot returns the number of general work requests. If it is -1, CommonSpot returns the total number of the site's work requests. |
| workRequestID | WorkRequestID_0 | Optional. Defaults to '0'. | A work request's ID. |
| filterCriteria | WorkRequestFilter | Optional. Defaults to 'All'. | A page's ID. If this value is 0, CommonSpot returns the number of general work requests. If it is -1, CommonSpot returns the total number of this site's work requests. |
| urgencyFilter | PriorityFilter | Optional. Defaults to 'All'. | A string identifying a work request's priority, as follows: 'All', 'High', 'Medium', or 'Low'. |
| workRequestStateFilter | WorkRequestStateFilter | Optional. Defaults to 'All'. | A string identifying a work request's state, as follows: 'completed', 'all', 'pending', 'accepted', 'rejected'. |
Context:
| License Requirements | None |
| Permission Requirements | Contributor |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | This method may be customized at the site level |
Error Codes:
None
Notes:
None