Get a report or template content
get
/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/{projectProgramCommunicationsUniqID}/child/Contents/{ObjectId}
Request
Path Parameters
-
ObjectId(required): integer(int64)
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=
-
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
-
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-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 : 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.
Examples
Example
The following example shows how to get a report or template content 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}/child/Contents/{ObjectId}"
Response Body
The following shows an example of the response body in JSON format.
{ "CreatedBy": "Carlton.Baugh", "CreationDate": "2023-05-18T12:46:43+00:00", "ItemDataType": null, "ItemListLookupCode": null, "LastUpdateDate": "2023-05-18T12:46:43.079+00:00", "LastUpdateLogin": "FB533DEFD649F614E053036015AC6344", "LastUpdatedBy": "Carlton.Baugh", "ObjectDescription": null, "ObjectDisplaySequence": 800, "ObjectDisplay": "N", "ObjectIcon": null, "ObjectId": "300100578891594", "ObjectLabelPosition": null, "ObjectLevel": 0, "ObjectName": "Test Subject", "ObjectGroupNewLine": "N", "ObjectParentId": "-1", "CatalogReferenceId": null, "ObjectTypeCode": "ORA_PJS_PPC_ITEM_GENERAL", "TableColumnHeaderOne": null, "TableColumnHeaderTwo": null, "TableColumnHeaderThree": null, "TableColumnHeaderFour": null, "TableColumnHeaderFive": null, "TableColumnHeaderSix": null, "TableColumnTypeOne": null, "TableColumnTypeTwo": null, "TableColumnTypeThree": null, "TableColumnTypeFour": null, "TableColumnTypeFive": null, "TableColumnTypeSix": null, "TableDefaultSortColumnNumber": null, "TableDefaultSortOrder": null, "TableGraphTypeCode": null, "ItemListLookup": null, "ObjectParentName": null, "ObjectType": "General item", "TableGraphTypeName": null, "TableDefaultSortColumn": null, "CatalogReference": null, "TableColumnValueOne": null, "TableColumnValueTwo": null, "TableColumnValueThree": null, "TableColumnValueFour": null, "TableColumnValueFive": null, "TableColumnValueSix": null, "ItemValue": null, "@context": { "key": "300100578891594", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" }, "links": [ { "rel": "self", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/300100578636594/child/Contents/300100578891594", "name": "Contents", "kind": "item" }, { "rel": "canonical", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/300100578636594/child/Contents/300100578891594", "name": "Contents", "kind": "item" }, { "rel": "parent", "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/projectProgramCommunications/300100578636594", "name": "projectProgramCommunications", "kind": "item" } ] } }