Jump to

• Request
• Response
• Examples

Manage views for program analysis

post

/fscmRestApi/resources/11.13.18.05/projectProgramUsers/{PersonId}/action/manageView

Manage views to create, update, or delete custom views for your program analysis.

Request

Path Parameters

• PersonId(required): number
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• action: string
  The action you want to perform. Values can be CREATE, UPDATE, or DELETE.
• existingViewName: string
  The name of the existing view that needs to be updated or deleted.
• newViewName: string
  The new name for the view, if you're performing an update operation.
• viewName: string
  The name of the custom view

{
    "type":"object",
    "properties":{
        "viewName":{
            "type":"string",
            "description":"The name of the custom view",
            "nullable":true
        },
        "existingViewName":{
            "type":"string",
            "description":"The name of the existing view that needs to be updated or deleted.",
            "nullable":true
        },
        "action":{
            "type":"string",
            "description":"The action you want to perform. Values can be CREATE, UPDATE, or DELETE.",
            "nullable":true
        },
        "newViewName":{
            "type":"string",
            "description":"The new name for the view, if you're performing an update operation.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  The status of the custom action, indicating whether the operation was successful. Values can be SUCCESS or FAILURE.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The status of the custom action, indicating whether the operation was successful. Values can be SUCCESS or FAILURE."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

Example 1

The following example shows how to create a custom view by submitting a POST request on the REST resource using cURL.

curl -H "Content-Type: application/vnd.oracle.adf.action+json" --user ppm_cloud_user -X POST -d @example_request_payload.json  "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramUsers/<PersonId>/action/manageView"

Example 1 Request Body

The following shows an example of the request body in JSON format.

{
"action": "create",
"viewName":"<custom view name>"
}

Example 1 Response Body

The following shows an example of the response body in JSON format.

{
    "result": "SUCCESS"
}

Example 2

The following example shows how to rename an existing custom view to a new name by submitting a POST request on the REST resource using cURL.

curl -H "Content-Type: application/vnd.oracle.adf.action+json" --user ppm_cloud_user -X POST -d @example_request_payload.json  "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramUsers/<PersonId>/action/manageView"

Example 2 Request Body

The following shows an example of the request body in JSON format.

{
"action": "update",
"existingViewName":"<Existing view name>",
"newViewName": "<New view name>"
}

Example 2 Response Body

The following shows an example of the response body in JSON format.

{
    "result": "SUCCESS"
}

Example 3

The following example shows how to delete an existing custom view by submitting a POST request on the REST resource using cURL.

curl -H "Content-Type: application/vnd.oracle.adf.action+json" --user ppm_cloud_user -X POST -d @example_request_payload.json  "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramUsers/<PersonId>/action/manageView"

Example 3 Request Body

The following shows an example of the request body in JSON format.

{
"action": "delete",
"viewName":"<view name to be deleted>"
}

Example 3 Response Body

The following shows an example of the response body in JSON format.

{
    "result": "SUCCESS"
}

Back to Top