Get a status report or template structure
get
/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}
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.
Query Parameters
-
dependency: string
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> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
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:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : projectProgramCommunications-item-response
Type:
Show Source
object
-
Associations: array
Project Program Communication Associations
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. -
BipPath: string
Maximum Length:
500
Unique path of the BIP layout file. -
Contents: array
Project Program Communication Contents
Title:
Project Program Communication Contents
The Contents resource is used to manage the data displayed in a generated report. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
Description: string
Maximum Length:
240
The description of the template or report. -
Feedbacks: array
Project Program Communication Feedback
Title:
Project Program Communication Feedback
Project Program Communication Feedback resource is used to manage the comments on the reports. -
LastGeneratedDate: string
(date-time)
Read Only:
true
The last generated date of the report. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Maximum Length:
120
The name of the template or report. -
OriginalAssociationId: integer
(int64)
Read Only:
true
The reference to the original template association used to generate specific report. -
OwnerPersonEmail: string
Title:
Email
Read Only:true
Maximum Length:240
The email of the template or report owner. -
OwnerPersonId: integer
(int64)
The person-ID of the template or report owner.
-
OwnerPersonName: string
Title:
Name
Read Only:true
Maximum Length:240
The template or report owner name. -
ReportId: integer
(int64)
Read Only:
true
The unique identifier of a template or report. -
SourceObjectName: string
Read Only:
true
Maximum Length:255
The name of the business object to which the report belongs, or the template is associated. -
SourceObjectNumber: string
Read Only:
true
Maximum Length:255
The unique number identifier of the business object to which the report belongs, or the template is associated. -
SourceObjectPublicFlag: boolean
Read Only:
true
Maximum Length:1
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
Read Only:
true
Maximum Length:255
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
(int64)
The identifier for the source report or template used to create this report or template.
-
SourceReportName: string
Read Only:
true
Maximum Length:255
The name for the source report or template used to create this report or template. -
SrcObjectId: integer
Read Only:
true
The unique identifier of an object to which the report belongs or a template is associated. -
Status: string
Maximum Length:
255
The status of the template or report like draft, unpublished, or published. -
StatusCode: string
Maximum Length:
30
Default Value:ORA_PJS_DRAFT
The code for the status of the template or report like DRAFT, UNPUBLISHED, or PUBLISHED. -
TemplateFlag: boolean
Maximum Length:
1
Default Value:true
The indicator specifying if the record is for a template or report.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectProgramCommunications-Associations-item-response
Type:
Show Source
object
-
Archived: string
Maximum Length:
1
Attribute indicating whether the reports are archived or not. -
AsOfPeriodName: string
Maximum Length:
15
The name of the program calendar period. The period with this name is the as-of-period for the measure time dimension. -
AssociationDescription: string
Maximum Length:
240
Description of the association. -
AssociationId: integer
(int64)
Read Only:
true
The unique identifier of an association of template or report to a business object. -
AssociationName: string
Maximum Length:
240
Name of the association. -
AutoPublish: string
The indicator specifying if a report gets auto-published.
-
AutoPublishCode: string
Maximum Length:
1
Default Value:N
The code for the indicator specifying if a report gets auto-published. -
CommunicationRecipients: array
Project Program Communication Recipients
Title:
Project Program Communication Recipients
The Recipients resource is used to manage the persons with whom the report is shared. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
Currency: string
Maximum Length:
255
The currency used for monetary amounts in the report. -
CurrencyCode: string
Maximum Length:
15
The currency code used for monetary amounts in the report. -
Frequency: string
The frequency for publishing the report for associated objects like daily, weekly, biweekly, monthly, quarterly, or yearly.
-
FrequencyCode: string
Maximum Length:
18
Default Value:ORA_PJS_MONTHLY
The frequency code for publishing the report for associated objects. -
InactiveFlag: boolean
Maximum Length:
1
Indicates the status of the report or a template. Only active templates can generate reports. -
LastGeneratedDate: string
(date-time)
Read Only:
true
The last generated date of the report. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextDueDate: string
(date-time)
Read Only:
true
The next due publishing date of the report. -
OwnerPersonEmail: string
Title:
Email
Read Only:true
Maximum Length:240
Email of the template or report owner. -
OwnerPersonId: integer
(int64)
Person-ID of the template or report owner.
-
OwnerPersonName: string
Title:
Name
Read Only:true
Maximum Length:240
The template or report owner. -
ReportId: integer
(int64)
The unique identifier of a template or report.
-
ScheduleStartDate: string
(date-time)
The start date for publishing a report based on its frequency.
-
SourceObjectId: integer
(int64)
The unique identifier of an object to which the report belongs or a template is associated.
-
SourceObjectName: string
Read Only:
true
Maximum Length:255
The name of the business object to which the report belongs, or the template is associated. -
SourceObjectNumber: string
Read Only:
true
Maximum Length:255
The unique number identifier of the business object to which the report belongs, or the template is associated. -
SourceObjectPublicFlag: boolean
Read Only:
true
Maximum Length:1
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
Read Only:
true
Maximum Length:255
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. -
Status: string
Read Only:
true
Maximum Length:255
The status of the template or report like draft, unpublished, or published. -
StatusCode: string
Read Only:
true
Maximum Length:255
The code for the status of the template or report like DRAFT, UNPUBLISHED, or PUBLISHED. -
TemplateFlag: boolean
Maximum Length:
1
The indicator specifying if the record is for a template or report.
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectProgramCommunications-Associations-CommunicationRecipients-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonEmail: string
Title:
Email
Read Only:true
Maximum Length:240
Email of the person receiving the report. -
PersonId: integer
(int64)
Unique identifier of the person receiving the report.
-
PersonName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the person receiving the report. -
ReportRecipientId: integer
(int64)
Unique identifier of the report recipient.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : projectProgramCommunications-Contents-item-response
Type:
Show Source
object
-
CatalogReference: string
Maximum Length:
255
Catalog reference of the report or template object. -
CatalogReferenceId: integer
(int64)
Identifier for the catalog reference of the report or template object.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
ItemDataType: string
Maximum Length:
30
The catalog object data type like text, number, amount, or date. -
ItemListLookup: string
Maximum Length:
255
The list of values that an item of type input-list is based on. -
ItemListLookupCode: string
Maximum Length:
30
The code for list of values that an item of type input-list is based on. -
ItemValue: string
Maximum Length:
4000
Data value for the report region item. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectDescription: string
Maximum Length:
240
The description of the template or report object. -
ObjectDisplay: string
Maximum Length:
1
Default Value:N
The indicator specifying if an item is displayed on the UI. -
ObjectDisplaySequence: integer
(int32)
The display order of an object in the report or template.
-
ObjectGroupNewLine: string
Maximum Length:
1
Default Value:N
The indicator specifying if an object appears in a new line in a report or template. -
ObjectIcon: string
Maximum Length:
500
The icon details for the object in the report or template. -
ObjectId: integer
(int64)
Read Only:
true
The unique identifier of an object within the report or template. -
ObjectLabelPosition: string
Maximum Length:
30
The label alignment of a catalog object like left, center, or right. -
ObjectLevel: integer
(int32)
Default Value:
0
The level in an object hierarchy in a report or a template. -
ObjectName: string
Maximum Length:
120
The title of the catalog object. -
ObjectParentId: integer
(int64)
Default Value:
-1
The parent object identifier of report or template items that are part of a group. -
ObjectParentName: string
Maximum Length:
255
The parent object name of report or template items that are part of a group. -
ObjectType: string
Maximum Length:
255
The types of objects like group, item, and table. -
ObjectTypeCode: string
Maximum Length:
30
The code for types of objects like group, item, and table. -
TableColumnHeaderFive: string
Maximum Length:
120
The header for the fifth column of the table type item. -
TableColumnHeaderFour: string
Maximum Length:
120
The header for the fourth column of the table type item. -
TableColumnHeaderOne: string
Maximum Length:
120
The header for the first column of the table type item. -
TableColumnHeaderSix: string
Maximum Length:
120
The header for the sixth column of the table type item. -
TableColumnHeaderThree: string
Maximum Length:
120
The header for the third column of the table type item. -
TableColumnHeaderTwo: string
Maximum Length:
120
The header for the second column of the table type item. -
TableColumnTypeFive: string
Maximum Length:
30
The type, like text, date, number, or amount, for the fifth column of the table-type items. -
TableColumnTypeFour: string
Maximum Length:
30
The type, like text, date, number, or amount, for the fourth column of the table-type items. -
TableColumnTypeOne: string
Maximum Length:
30
The type, like text, date, number, or amount, for the first column of the table-type items. -
TableColumnTypeSix: string
Maximum Length:
30
The type, like text, date, number, or amount, for the sixth column of the table-type items. -
TableColumnTypeThree: string
Maximum Length:
30
The type, like text, date, number, or amount, for the third column of the table-type items. -
TableColumnTypeTwo: string
Maximum Length:
30
The type, like text, date, number, or amount, for the second column of the table-type items. -
TableColumnValueFive: string
Maximum Length:
400
The value of the fifth column of the table type item. -
TableColumnValueFour: string
Maximum Length:
400
The value of the fourth column of the table type item. -
TableColumnValueOne: string
Maximum Length:
400
The value for the first column of the table type item. -
TableColumnValueSix: string
Maximum Length:
400
The value for the sixth column of the table type item. -
TableColumnValueThree: string
Maximum Length:
400
The value for the third column of the table type item. -
TableColumnValueTwo: string
Maximum Length:
400
The value for the second column of the table type item. -
TableDefaultSortColumn: string
Maximum Length:
255
The default column for sorting table data. -
TableDefaultSortColumnNumber: integer
(int32)
The default column number for sorting table data.
-
TableDefaultSortOrder: string
Maximum Length:
30
The default sort order, like ascending or descending, on a table column. -
TableGraphTypeCode: string
Maximum Length:
30
The code for the default graph type which is required only for a table-type item like bar or pie graph. -
TableGraphTypeName: string
Maximum Length:
255
The default graph type, like bar or pie, to be rendered for a table-type item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectProgramCommunications-Feedbacks-item-response
Type:
Show Source
object
-
CommentText: string
Maximum Length:
400
Additional comment from the recipient of the report in free text form. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
Emoticon: string
Maximum Length:
80
Emoticon code that corresponds to each supported emoji. -
FeedbackId: integer
(int64)
Read Only:
true
Unique identifier of the feedback given as comment for the report. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login details of user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PersonEmail: string
Title:
Email
Read Only:true
Maximum Length:240
Email of the person writing the comment. -
PersonId: integer
(int64)
Unique identifier of the person writing the comment.
-
PersonName: string
Title:
Name
Read Only:true
Maximum Length:240
Name of the person writing the comment. -
ReportId: integer
(int64)
The unique identifier of a template or report.
-
ReportObjectId: integer
(int64)
Unique identifier for the object in a report.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Associations
-
Parameters:
- projectProgramCommunicationsUniqID:
$request.path.projectProgramCommunicationsUniqID
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. - projectProgramCommunicationsUniqID:
- Contents
-
Parameters:
- projectProgramCommunicationsUniqID:
$request.path.projectProgramCommunicationsUniqID
The Contents resource is used to manage the data displayed in a generated report. - projectProgramCommunicationsUniqID:
- Feedbacks
-
Parameters:
- projectProgramCommunicationsUniqID:
$request.path.projectProgramCommunicationsUniqID
Project Program Communication Feedback resource is used to manage the comments on the reports. - projectProgramCommunicationsUniqID:
- downloadBipReport
-
Parameters:
- projectProgramCommunicationsUniqID:
$request.path.projectProgramCommunicationsUniqID
Download the program BIP report to share and communicate the health of the program with stakeholders. - projectProgramCommunicationsUniqID:
Examples
Example
The following example shows how to get a status report or template structure by submitting a GET request on the REST resource using cURL.
curl --user ppm_cloud_user -X GET-d @example_request_payload.json "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{ReportId}"
Response Body
The following shows an example of the response body in JSON format.
{ "ReportId": "100102831190700", "SourceReportId": "10000", "Name": "May 18 2023 (07:02)", "Description": "Demo Report May 18 2023 (07:02)", "OwnerPersonId": "100010026863799", "CreatedBy": "Carlton.Baugh", "CreationDate": "2023-05-18T07:02:30+00:00", "LastUpdatedBy": "Carlton.Baugh", "LastUpdateDate": "2023-05-18T07:02:30+00:00", "LastUpdateLogin": "F92A0D45C4074D12E053866515AC8C5A", "BipPath": null, "Status": "Draft", "SourceReportName": null, "StatusCode": "ORA_PJS_DRAFT", "TemplateFlag": false, "OwnerPersonName": "Devon Smith", "SourceObjectName": "test demo", "SourceObjectNumber": "test demo", "SrcObjectId": "300100575973953", "OriginalAssociationId": "300100576022267", "LastGeneratedDate": null, "OwnerPersonEmail": "sendmail-test-discard@vision.com", "@context": { "key": "100102831190700", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" }, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/100102831190700", "name": "projectProgramCommunications", "kind": "item" }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/100102831190700", "name": "projectProgramCommunications", "kind": "item" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/100102831190700/child/Associations", "name": "Associations", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/100102831190700/child/Contents", "name": "Contents", "kind": "collection" }, { "rel": "child", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/100102831190700/child/Feedbacks", "name": "Feedbacks", "kind": "collection" }, { "rel": "action", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/100102831190700/action/downloadBipReport", "name": "downloadBipReport", "kind": "other" } ] } }