1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Project Program Communications

Get all status reports or templates structure

get

/fscmRestApi/resources/11.13.18.05/projectProgramCommunications

Request

Query Parameters
  • This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Find all the reports for the specified primary key.
      Finder Variables
      • ReportId; integer; Unique identifier of a template or report.
    • findBySourceObjectId Find all the reports associated with the specified source object ID to which the report belongs.
      Finder Variables
      • SourceObjectId; integer; Unique identifier of an object to which the report belongs or a template is associated.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • BipPath; string; Unique path of the BIP layout file.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • Description; string; The description of the template or report.
    • LastGeneratedDate; string; The last generated date of the report.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdateLogin; string; The login details of user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • Name; string; The name of the template or report.
    • OriginalAssociationId; integer; The reference to the original template association used to generate specific report.
    • OwnerPersonEmail; string; The email of the template or report owner.
    • OwnerPersonId; integer; The person-ID of the template or report owner.
    • OwnerPersonName; string; The template or report owner name.
    • ReportId; integer; The unique identifier of a template or report.
    • SourceObjectName; string; The name of the business object to which the report belongs, or the template is associated.
    • SourceObjectNumber; string; The unique number identifier of the business object to which the report belongs, or the template is associated.
    • SourceObjectPublicFlag; boolean; The public access indicator for the program with which a report or template is associated. For example, if the report is associated with the North America Implementations program, this attribute indicates whether the program can be publicly accessed within the organization.
    • SourceObjectUserAccess; string; The access type that a logged-in user has to the program or template associated with a report. For example, if the report belongs to the North America Implementations program and the logged-in user owns the program, this attribute has the value ORA_PJS_OWNER.
    • SourceReportId; integer; The identifier for the source report or template used to create this report or template.
    • SourceReportName; string; The name for the source report or template used to create this report or template.
    • SrcObjectId; integer; The unique identifier of an object to which the report belongs or a template is associated.
    • Status; string; The status of the template or report like draft, unpublished, or published.
    • StatusCode; string; The code for the status of the template or report like DRAFT, UNPUBLISHED, or PUBLISHED.
    • TemplateFlag; boolean; The indicator specifying if the record is for a template or report.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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.
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : projectProgramCommunications
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectProgramCommunications-item-response
Type: object
Show Source
Nested Schema : Project Program Communication Associations
Type: array
Title: Project Program Communication Associations
Associations resource is used to manage the association of templates or reports to a business object like a program. A template is associated with a program to generate the corresponding report.
Show Source
Nested Schema : Project Program Communication Contents
Type: array
Title: Project Program Communication Contents
The Contents resource is used to manage the data displayed in a generated report.
Show Source
Nested Schema : Project Program Communication Feedback
Type: array
Title: Project Program Communication Feedback
Project Program Communication Feedback resource is used to manage the comments on the reports.
Show Source
Nested Schema : projectProgramCommunications-Associations-item-response
Type: object
Show Source
Nested Schema : Project Program Communication Recipients
Type: array
Title: Project Program Communication Recipients
The Recipients resource is used to manage the persons with whom the report is shared.
Show Source
Nested Schema : projectProgramCommunications-Associations-CommunicationRecipients-item-response
Type: object
Show Source
Nested Schema : projectProgramCommunications-Contents-item-response
Type: object
Show Source
Nested Schema : projectProgramCommunications-Feedbacks-item-response
Type: object
Show Source
Back to Top