IRPCApplicationTaskQueue.GetTaskIdentifiersFromQueue
Server integration API / specialized write session
Gets the IDs of the tasks of a queue that are in the given states.
| Service | Application task queue MFiles.IRPCApplicationTaskQueue |
|---|---|
| gRPC method | /MFiles.IRPCApplicationTaskQueue/GetTaskIdentifiersFromQueue |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-task-identifiers-from-queue |
| Request | GetTaskIdentifiersFromQueueRequest |
| Response | GetTaskIdentifiersFromQueueResponse |
| Book and level | Server integration API, specialized |
| Kind | write |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- For diagnostics; reserves nothing. An unknown queue returns an empty list.
- Requires a vault session and the vault right
change_full_control_role.
Request: GetTaskIdentifiersFromQueueRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
queue_id | string | The ID of the queue. |
included_states | string | The states to include, as a comma-separated list of ApplicationTaskState numbers, for example 0,1 for waiting and in progress. Must not be empty and must not repeat a state; otherwise the call fails with "The parameter is incorrect.". |
Response: GetTaskIdentifiersFromQueueResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
task_id_collection[] | repeated string | The IDs of the matching tasks. |