ZZ00348: ICO 2.4.0 DOC: TASK ENGINE REST API V2 SECTION - HAS TYPO IN URL METHODS LISTED

IBM Cloud Orchestrator Fix Pack 2 (2.4.0.2) for 2.4
IBM Cloud Orchestrator Fix Pack 3 (2.4.0.3) for 2.4
IBM Cloud Orchestrator Interim Fix 1 for 2.4.0.2

APAR status

• Closed as documentation error.

Error description

• https://www-
  304.ibm.com/support/knowledgecenter/SS4KMC_2.4.0/com.ibm.sco.doc
  _2.4/r_task_engine_apiv2.html
  
  IBM Cloud Orchestrator 2.4.0>Reference>REST API reference>Core
  Services REST API>Task Engine REST API V2
  
  All 5 references to the "URL method" should read /orchestrator
  instead of /orchestration.
  
  Ie.,:
  
  URL method
      /orchestration/v2/tasks
  
  ...should be:
  
  URL method
      /orchestrator/v2/tasks
  

Local fix

• N/A
  

Problem summary

• ****************************************************************
  * USERS AFFECTED: All users of SmartCloud Orchestrator 2.4
  ****************************************************************
  * PROBLEM DESCRIPTION:
  
  ICO 2.4.0 DOC: TASK ENGINE REST API V2 SECTION - HAS TYPO IN URL
  METHODS LISTED
  http://www-01.ibm.com/support/knowledgecenter/SS4KMC_2.4.0.1/com
  .ibm.sco.doc_2.4/r_task_engine_apiv2.html?lang=en
  
  URL method
  /orchestration/v2/tasks
  should read:
  
  URL pattern
  /orchestrator/v2/tasks
  
  ****************************************************************
  * RECOMMENDATION:
  Review the next update of IBM Cloud Orchestrator Information
  Center when available.
  
  The documentation changes can also be found in the conclusion
  section below.
  

Problem conclusion

• Task Engine REST API V2
  JSON Formats
  Task Response
  
  {
       "updated_iso" : "2014-03-31T13:05:14+0200",
       "description_message" : "The process is complete.",
       "domain" : "Default",
       "created" : 1396263830875,
       "error" : {
           "resourceBundle" :
  "com.ibm.orchestrator.messages.orchestratormessages",
           "message" : null,
           "messageKey" : "BPM_PROCESS_COMPLETE",
           "args" :
           [
               "3"
           ]
       },
       "user" : "ksadmin",
       "parm" : {
           .....
       },
       "created_iso" : "2014-03-31T13:03:50+0200",
       "status_localized" : "Completed",
       "error_message" : "CTJCO0002I: Business process instance 3
  completed successfully.",
       "status" : "COMPLETED",
       "eventTopic" :
  "com/ibm/orchestrator/serviceinstance/plan/ibm_bpm_process",
       "delayInSeconds" : 30,
       "project" : "admin",
       "id" : "1003",
       "updated" : 1396263914896,
       "description" : {
           "resourceBundle" :
  "com.ibm.orchestrator.messages.orchestratormessages",
           "message" : null,
           "messageKey" : "PROCESS_COMPLETE",
           "args" :
           [
           ]
       }
   }
  Task Response
  
  [ Task Response 1,....., Task Response n]
  
  GET: Get all tasks
  
  URL method
  /orchestrator/v2/tasks
  Accepts
  */*
  Content-Type
  application/JSON
  Normal response Codes
  200
  Error Response Codes
  500 internal server error
  Request Parameters
  Expand: if set to serviceInstance the information service
  instance referred by the attribute serviceInstanceId will get
  returned in the Task Response in the parameter serviceInstance.
  Response
  Tasks Response
  Authorization
  No authorization needed but the output is restricted to tasks
  from all users within the current project. Users with role admin
  can see all the tasks.
  POST: Get all tasks
  
  URL method
  /orchestrator/v2/tasks
  Accepts
  */*
  Content-Type
  application/JSON
  Normal Response Codes
  201 created
  Error Response Codes
  401 unauthorized
  500 internal server error
  Response
  Tasks Response
  Authorization
  role: admin
  GET: Get the task with a given id
  
  URL method
  /orchestrator/v2/tasks/{id}
  Accepts
  */*
  Content-Type
  application/JSON
  Normal Response Codes
  200
  Error Response Codes
  404 not found
  500 internal server error
  Response
  task Response
  Authorization
  No authorization needed but output restricted to role
  PUT : Get the task with a given id
  
  URL pattern
  /orchestrator/v2/tasks/{id}
  Accepts
  */*
  Content-Type
  application/JSON
  Normal Response Codes
  200
  Error Response Codes
  401 unauthorized
  404 not found
  500 internal server error
  Response
  Task Response
  Authorization
  role: admin or in same project as task
  DELETE: Delete the task with a given id
  
  URL pattern
  /orchestrator/v2/tasks/{id}
  Accepts
  */*
  Content-Type
  application/JSON
  Normal response Codes
  204
  Error Response Codes
  401 unauthorized
  404 not found
  500 internal server error
  Response
  Task Response
  Authorization
  role: admin
  

Temporary fix

Comments

APAR Information

• APAR is sysrouted FROM one or more of the following:

• APAR is sysrouted TO one or more of the following:

Fix information

Applicable component levels