Get all report or template associations
get
/fscmRestApi/resources/11.13.18.05/projectProgramCommunicationAssociations
Request
Query Parameters
-
effectiveDate: string
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
-
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 -
finder: string
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 all associations for the specified primary key.
Finder Variables- AssociationId; integer; Unique identifier of an association of template or report to a business object.
- PrimaryKey Finds all associations for the specified primary key.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- Archived; string; Attribute indicating whether the reports are archived or not.
- AsOfPeriodName; string; The name of the program calendar period. The period with this name is the as-of-period for the measure time dimension.
- AssociationDescription; string; Description of the association.
- AssociationId; integer; The unique identifier of an association of template or report to a business object.
- AssociationName; string; Name of the association.
- AutoPublish; string; The indicator specifying if a report gets auto-published.
- AutoPublishCode; string; The code for the indicator specifying if a report gets auto-published.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- Currency; string; The currency used for monetary amounts in the report.
- CurrencyCode; string; 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; The frequency code for publishing the report for associated objects.
- InactiveFlag; boolean; Indicates the status of the report or a template. Only active templates can generate reports.
- 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.
- NextDueDate; string; The next due publishing date of the report.
- OwnerPersonEmail; string; Email of the template or report owner.
- OwnerPersonId; integer; Person-ID of the template or report owner.
- OwnerPersonName; string; The template or report owner.
- ReportId; integer; The unique identifier of a template or report.
- ScheduleStartDate; string; The start date for publishing a report based on its frequency.
- SourceObjectId; integer; The unique identifier of an object to which the report belongs or a template is associated.
- 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.
- 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.
-
totalResults: boolean
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
-
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 : projectProgramCommunicationAssociations
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : projectProgramCommunicationAssociations-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. -
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 : 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.