Jump to

• Request
• Response
• Examples

Generate and Export a Report for a Process

put

/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes/{processId}/report

Generate and export a report for a process in an application. The report can include descriptions and information such as requirements, links to attachments, and tracking of issues and comments.

Request

Path Parameters

• processId(required): string
  The process ID
• projectId(required): string
  The project ID
• spaceId(required): string
  The space ID

Query Parameters

• format: string
  Specify report file format.

  Default Value: XML

  Allowed Values: [ "XML", "HTML", "PDF", "HTML/Zip" ]
• showBiz: boolean
  Set show business properties checkbox.

  Default Value: false
• showDoc: boolean
  Set show documentation checkbox.

  Default Value: false
• type: string
  Specify the report type.

  Default Value: DETAILED_BPR

  Allowed Values: [ "DETAILED_BPR", "BIZ_REQS", "ISSUES_COMMENTS", "DATA_OBJECTS", "PROCESS_VS_DATA", "DATA_VS_PROCESS", "SERVICE_VS_PROCESS", "USER_TASK", "PROCESS_PROPS", "RACI" ]

Back to Top

Response

Supported Media Types

• application/xml
• text/html
• application/pdf
• application/octet-stream

200 Response

Success. Report successfully generated.

401 Response

Unauthorized

403 Response

Privileges required. User can't generate the report.

404 Response

Space/Project not found. Invalid report/format values.

500 Response

Error in generating the report.

Back to Top

Examples

The following example shows how to generate and export a report for a specific process in an application in a space by submitting a PUT request on the REST resource.

Send Request

The following example shows the contents of the send request:

curl -X PUT https://example.com/ic/api/process/<version>/spaces/<spaceId>/projects/<projectId>/processes/{processId}/report

Where,

• example.com is the host where Oracle Integration is running.

• <version> is the REST API version.

• <spaceId> is the unique ID for a space.

• <projectId> is the unique ID for a project.

• <processId> is the unique ID for a process.

Example of Response Header

Status Code: 200 OK
Date:  Mon, 18 Mar 2022 08:39:54 GMT
Content-Type: application/xml

Back to Top