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

Get all status reports or template content

get

/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Contents

Request

Path Parameters
  • 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.
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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 Finds the report content for the specified primary key.
      Finder Variables
      • ObjectId; integer; Unique identifier of an object within the report or template.
  • 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:
    • CatalogReference; string; Catalog reference of the report or template object.
    • CatalogReferenceId; integer; Identifier for the catalog reference of the report or template object.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • ItemDataType; string; The catalog object data type like text, number, amount, or date.
    • ItemListLookup; string; The list of values that an item of type input-list is based on.
    • ItemListLookupCode; string; The code for list of values that an item of type input-list is based on.
    • ItemValue; string; Data value for the report region item.
    • 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.
    • ObjectDescription; string; The description of the template or report object.
    • ObjectDisplay; string; The indicator specifying if an item is displayed on the UI.
    • ObjectDisplaySequence; integer; The display order of an object in the report or template.
    • ObjectGroupNewLine; string; The indicator specifying if an object appears in a new line in a report or template.
    • ObjectIcon; string; The icon details for the object in the report or template.
    • ObjectId; integer; The unique identifier of an object within the report or template.
    • ObjectLabelPosition; string; The label alignment of a catalog object like left, center, or right.
    • ObjectLevel; integer; The level in an object hierarchy in a report or a template.
    • ObjectName; string; The title of the catalog object.
    • ObjectParentId; integer; The parent object identifier of report or template items that are part of a group.
    • ObjectParentName; string; The parent object name of report or template items that are part of a group.
    • ObjectType; string; The types of objects like group, item, and table.
    • ObjectTypeCode; string; The code for types of objects like group, item, and table.
    • TableColumnHeaderFive; string; The header for the fifth column of the table type item.
    • TableColumnHeaderFour; string; The header for the fourth column of the table type item.
    • TableColumnHeaderOne; string; The header for the first column of the table type item.
    • TableColumnHeaderSix; string; The header for the sixth column of the table type item.
    • TableColumnHeaderThree; string; The header for the third column of the table type item.
    • TableColumnHeaderTwo; string; The header for the second column of the table type item.
    • TableColumnTypeFive; string; The type, like text, date, number, or amount, for the fifth column of the table-type items.
    • TableColumnTypeFour; string; The type, like text, date, number, or amount, for the fourth column of the table-type items.
    • TableColumnTypeOne; string; The type, like text, date, number, or amount, for the first column of the table-type items.
    • TableColumnTypeSix; string; The type, like text, date, number, or amount, for the sixth column of the table-type items.
    • TableColumnTypeThree; string; The type, like text, date, number, or amount, for the third column of the table-type items.
    • TableColumnTypeTwo; string; The type, like text, date, number, or amount, for the second column of the table-type items.
    • TableColumnValueFive; string; The value of the fifth column of the table type item.
    • TableColumnValueFour; string; The value of the fourth column of the table type item.
    • TableColumnValueOne; string; The value for the first column of the table type item.
    • TableColumnValueSix; string; The value for the sixth column of the table type item.
    • TableColumnValueThree; string; The value for the third column of the table type item.
    • TableColumnValueTwo; string; The value for the second column of the table type item.
    • TableDefaultSortColumn; string; The default column for sorting table data.
    • TableDefaultSortColumnNumber; integer; The default column number for sorting table data.
    • TableDefaultSortOrder; string; The default sort order, like ascending or descending, on a table column.
    • TableGraphTypeCode; string; The code for the default graph type which is required only for a table-type item like bar or pie graph.
    • TableGraphTypeName; string; The default graph type, like bar or pie, to be rendered for a table-type item.
  • 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
  • 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-Contents
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : projectProgramCommunications-Contents-item-response
Type: object
Show Source
Back to Top