Jump to

• Request
• Response

Generate or update a report with the latest data

post

/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/action/createAndRefreshReport

Generate a new report if one doesn't exist, or update an existing report with the latest data

Request

Path Parameters

• projectProgramCommunicationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Project Program Communications resource and used to uniquely identify an instance of Project Program Communications. The client should not generate the hash key value. Instead, the client should query on the Project Program Communications collection resource in order to navigate to a specific instance of Project Program Communications to get the hash key.

Header Parameters

• Effective-Of: string
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• Metadata-Context: string
  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: string
  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

• associationName: string
  Name of the association.
• callingMode: string
  Specifies the operation to perform: Refresh (updates an existing report) or CreateAndRefresh (creates a new report with the latest data).
• personId: number
  The person ID of the template or report owner.
• sourceObjectId: number
  The unique identifier of an object, such as a program or a project, with which the report is associated.
• sourceObjectType: string
  Identifies the type of source object, such as a program or a project proposal, with which the report is associated.

{
    "type":"object",
    "properties":{
        "callingMode":{
            "type":"string",
            "description":"Specifies the operation to perform: Refresh (updates an existing report) or CreateAndRefresh (creates a new report with the latest data).",
            "nullable":true
        },
        "sourceObjectType":{
            "type":"string",
            "description":"Identifies the type of source object, such as a program or a project proposal, with which the report is associated.",
            "nullable":true
        },
        "associationName":{
            "type":"string",
            "description":"Name of the association.",
            "nullable":true
        },
        "personId":{
            "type":"number",
            "description":"The person ID of the template or report owner.",
            "nullable":true
        },
        "sourceObjectId":{
            "type":"number",
            "description":"The unique identifier of an object, such as a program or a project, with which the report is associated.",
            "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
  Returns the ID of the generated or updated report on success, and an error message on failure.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"Returns the ID of the generated or updated report on success, and an error message on failure."
        }
    },
    "additionalProperties":false
}

Back to Top