Guided Tasks
productManagementGuidedTasks Based on 26C
Create, change, delete and look up Guided Tasks, with guided task instances and guided task steps.
- Operations
- GET (list)GET (one)POST (create)PATCH (update)DELETE1 action
- Record key
guidedTaskId- Required on create
headerObjectstatus- At a glance
- 15 fields0 finders3 children1 file/large text fields
Try it
Only attributes Oracle marks as searchable are offered.
GET /fscmRestApi/resources/11.13.18.05/productManagementGuidedTasks?fields=ObjectVersionNumber,createdBy,description,globalContext,guidedTaskId&limit=25&onlyData=true
{
"items": [
{
"ObjectVersionNumber": 0,
"createdBy": "<string, max 64>",
"description": "<string, max 1000>",
"globalContext": "<string, max 3000>",
"guidedTaskId": 0
}
],
"count": 25,
"hasMore": true,
"limit": 25,
"offset": 0
}Shapes and placeholders, not real data. Replace https://<your-pod> and the login with your own: this site never sees them. Based on Oracle's 26C REST specification.
Fields 15
| Attribute | Type | Use |
|---|---|---|
ObjectVersionNumber | number | Read-onlySearchable |
createdBy | text · max 64 | Read-onlySearchable |
description | text · max 1000 | Optional on createUpdatableSearchable |
globalContext | text · max 3000 | Optional on createUpdatableSearchable |
guidedTaskId | number | Optional on createSearchable |
headerObject | text · max 150 | Required on createUpdatableSearchable |
headerObjectValue | text · max 255 | Read-only |
image | text | Optional on createUpdatable |
name | text · max 150 | Optional on createUpdatableSearchable |
status | text · max 100 | Required on createUpdatableSearchable |
statusValue | text · max 255 | Read-only |
timeCreated | date-time | Read-onlySearchable |
timeUpdated | date-time | Read-onlySearchable |
updatedBy | text · max 64 | Read-onlySearchable |
visibility | text · max 150 | Optional on createUpdatableSearchable |
Names, types, labels and flags from Oracle's REST specification (26C). Flexfield and custom attributes vary by pod: check /describe for yours.
Check a payload
Checked in your browser only; nothing you paste is sent anywhere. Checks names and flags, not values.
Children 3
Child resources sit under one record: /fscmRestApi/resources/11.13.18.05/productManagementGuidedTasks/{guidedTaskId}/child/<name>. Add them to a GET with expand.
guidedTaskInstancesGET · POST · PATCH · DELETE Guided Task Instances · 13 fieldsObjectVersionNumbercreatedBydescriptioninstanceIdjobIdmetadatanamestatusstatusValuetaskConfigMetadatatimeCreatedtimeUpdatedupdatedByguidedTaskStepsGET · POST · PATCH · DELETE Guided Task Steps · 14 fieldsObjectVersionNumbercreatedBydescriptionnamestepIdstepNumberstepObjectstepObjectValuestepSearchViewIdsstepTypestepTypeValuetimeCreatedtimeUpdatedupdatedByobjectSearchViewsGET · POST · PATCH · DELETE Object Search Views · 13 fieldsObjectVersionNumberSearchConfigDatacreatedByhintlabelnameobjectobjectValuesearchConfigsearchViewIdtimeCreatedtimeUpdatedupdatedBy
Actions 1
POST …/{guidedTaskId}/child/guidedTaskInstances/{instanceId}/action/performBatch·batchId
Actions use Content-Type: application/vnd.oracle.adf.action+json. A path with a {key} runs on one record.
Use in AI Agent Studio
- Point a Business Object or REST tool at
/fscmRestApi/resources/11.13.18.05/productManagementGuidedTasksand ask only for the fields the agent needs withfields=. Big responses cost tokens and slow the agent. - Narrow with
q=on searchable fields and a smalllimit; for a count usetotalResults=true&limit=1. - Call once and pass the result on to later steps rather than calling the same endpoint again.
- This resource can change data. Put a human approval step before any create, update, delete or action call.
More in For Builders.
Pitfalls
- Attribute names are case-sensitive in
q,fieldsand bodies:description, notdescription. - 7 fields are read-only: sending them in POST or PATCH fails or is ignored. The builder leaves them out.
- Send dates as
YYYY-MM-DD; date-time fields take ISO 8601 with a time zone. - A list returns 25 rows unless you set
limit; readhasMoreand moveoffsetto page through. - Text fields have maximum lengths (shown in the field table). Longer values are rejected.