Get all service indicators
get
/fscmRestApi/resources/11.13.18.05/administrativeServiceIndicators
Request
Query Parameters
-
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- CurrentServiceIndicatorFinder Finds all service indicators that have current date between start date and end date.
Finder Variables - PrimaryKey Finds all service indicators that match the primary key criteria specified.
Finder Variables- ServiceIndicatorId; integer; Unique identifier for a service indicator.
- CurrentServiceIndicatorFinder Finds all service indicators that have current date between start date and end date.
-
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:- Comments; string; The comment entered when assigning a service indicator.
- EndDate; string; The date when the service indicator assignment ends.
- EndReportingPeriodId; integer; The unique identifier for an ending reporting period. A service indicator can be assigned for a duration of starting and ending reporting periods.
- EndReportingPeriodName; string; The name of an ending reporting period.
- IndicatorId; integer; The unique identifier for a service indicator.
- IndicatorName; string; The name of a service indicator.
- IndicatorReasonId; integer; The unique identifier for a service indicator reason.
- IndicatorReasonName; string; The name of a service indicator reason.
- IndicatorTypeCode; string; The service indicator type code. Valid values include ORA_SERVICE_PROVIDED or ORA_SERVICE_RESTRICTED. A list of accepted values is defined in the lookup type ORA_HEY_SERVICE_TYPE.
- IndicatorTypeMeaning; string; The meaning of the service indicator type. Valid values include Service provided or Service restricted. A list of accepted values is defined in the lookup type ORA_HEY_SERVICE_TYPE.
- PartyId; integer; The trading community party to whom the indicator has been assigned.
- ServiceIndicatorId; integer; The unique identifier for a service indicator.
- ShowCommentsToRecipientFlag; boolean; Indicates whether the comment should be shown or not.
- ShowToRecipientFlag; boolean; Indicates whether the indicator is visible to the recipient. Recipient is the individual to whom the indicator is assigned. Valid values are Y when indicator is visible and N when indicator isn't visible.
- StartDate; string; The date when the service indicator assignment starts.
- StartReportingPeriodId; integer; The unique identifier for a starting reporting period. A service indicator can be assigned for a duration of starting and ending reporting periods.
- StartReportingPeriodName; string; The name of a starting reporting period.
-
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
-
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 : administrativeServiceIndicators
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 : administrativeServiceIndicators-item-response
Type:
Show Source
object
-
Comments: string
Title:
Comments
Maximum Length:240
The comment entered when assigning a service indicator. -
EndDate: string
(date)
Title:
End Date
The date when the service indicator assignment ends. -
EndReportingPeriodId: integer
(int64)
Title:
Reporting Period End ID
The unique identifier for an ending reporting period. A service indicator can be assigned for a duration of starting and ending reporting periods. -
EndReportingPeriodName: string
Title:
Reporting Period End Name
Read Only:true
Maximum Length:50
The name of an ending reporting period. -
IndicatorId: integer
(int64)
Title:
Indicator ID
The unique identifier for a service indicator. -
indicatorImpacts: array
Indicator Impacts
Title:
Indicator Impacts
The indicator impacts resource provides a list of services that are impacted due to the assignment of the service indicator. -
IndicatorName: string
Title:
Indicator Name
Read Only:true
Maximum Length:60
The name of a service indicator. -
IndicatorReasonId: integer
(int64)
Title:
Indicator Reason ID
The unique identifier for a service indicator reason. -
IndicatorReasonName: string
Title:
Indicator Reason Name
Read Only:true
Maximum Length:60
The name of a service indicator reason. -
IndicatorTypeCode: string
Read Only:
true
Maximum Length:30
The service indicator type code. Valid values include ORA_SERVICE_PROVIDED or ORA_SERVICE_RESTRICTED. A list of accepted values is defined in the lookup type ORA_HEY_SERVICE_TYPE. -
IndicatorTypeMeaning: string
Read Only:
true
Maximum Length:80
The meaning of the service indicator type. Valid values include Service provided or Service restricted. A list of accepted values is defined in the lookup type ORA_HEY_SERVICE_TYPE. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PartyId: integer
(int64)
The trading community party to whom the indicator has been assigned.
-
ServiceIndicatorId: integer
(int64)
Title:
Service Indicator ID
The unique identifier for a service indicator. -
ShowCommentsToRecipientFlag: boolean
Title:
Show to Recipient
Maximum Length:1
Indicates whether the comment should be shown or not. -
ShowToRecipientFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the indicator is visible to the recipient. Recipient is the individual to whom the indicator is assigned. Valid values are Y when indicator is visible and N when indicator isn't visible. -
StartDate: string
(date)
Title:
Start Date
The date when the service indicator assignment starts. -
StartReportingPeriodId: integer
(int64)
Title:
Reporting Period Start ID
The unique identifier for a starting reporting period. A service indicator can be assigned for a duration of starting and ending reporting periods. -
StartReportingPeriodName: string
Title:
Reporting Period Start Name
Read Only:true
Maximum Length:50
The name of a starting reporting period.
Nested Schema : Indicator Impacts
Type:
array
Title:
Indicator Impacts
The indicator impacts resource provides a list of services that are impacted due to the assignment of the service indicator.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : administrativeServiceIndicators-indicatorImpacts-item-response
Type:
Show Source
object
-
IndicatorImpactId: integer
(int64)
Read Only:
true
The unique identifier for a service indicator and service impact association. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ServiceImpactCode: string
Title:
Code
Read Only:true
Maximum Length:30
The unique code that identifies the service impact, such as BLENR, for block enrollment service impact. -
ServiceImpactId: integer
(int64)
Read Only:
true
The service impact identifier for the service indicator. -
ServiceImpactName: string
Title:
Impact
Read Only:true
Maximum Length:60
The name of the service impact, such as, Hold Transcript. -
ShowToRecipientFlag: boolean
Read Only:
true
Maximum Length:1
Indicates whether the service impact is visible to the recipient. Recipient is the individual to whom the impact is assigned. Valid values are Y when service impact is visible to the recipient and N when impact isn't visible.
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.