Get all consumer rows
get
/fscmRestApi/resources/11.13.18.05/dataGetterConsumers
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- PrimaryKey Finds all data selection consumers that match the primary key criteria specified.
Finder Variables- ConsumerId; integer; Unique identifier for the data selection consumer.
- PrimaryKey Finds all data selection consumers that match the primary key criteria specified.
-
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:- ConsumerCode; string; Data selection tool consumer unique code, such as COMM, RULES, or ADMISSIONS.
- ConsumerId; integer; Data selection tool consumer unique identifier.
- ConsumerName; string; Name of the data selection tool consumer, such as the Fee discount calculation process.
- ConsumerTypeCode; string; Type of the data selection tool consumer, for example, a process or a transaction. A list of accepted values is defined in the lookup type ORA_HEY_CONSUMER_TYPE_CODE.
- DataProfileUsageTypeCode; string; Data profile usage type code that a data selection tool consumer has access to, for example, all profiles or consumer specific profiles. A list of accepted values is defined in the lookup type ORA_HEY_DATA_PROFILE_USE.
- DefaultQueryOwnershipFlag; boolean; Indicates if the data selection tool consumer can own a query by default or not.
- Description; string; Description of the data selection tool consumer.
- ReferenceAttributeName; string; Data selection tool consumer source table attribute name in which query usage reference ID is stored.
- SelectAllColumnsFlag; boolean; Indicates if all columns of the view objects need to be selected by default or not in query creation UI flows.
- SourceTableName; string; Data selection tool consumer source table name. Used to scan for orphan query usage entries. These entries indicate queries for which usage is unknown.
-
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 : dataGetterConsumers
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 : dataGetterConsumers-item-response
Type:
Show Source
object
-
ConsumerCode: string
Title:
Consumer Code
Maximum Length:50
Data selection tool consumer unique code, such as COMM, RULES, or ADMISSIONS. -
ConsumerId: integer
(int64)
Title:
Consumer ID
Data selection tool consumer unique identifier. -
ConsumerName: string
Title:
Consumer Name
Maximum Length:100
Name of the data selection tool consumer, such as the Fee discount calculation process. -
ConsumerTypeCode: string
Title:
Consumer Type Code
Maximum Length:30
Type of the data selection tool consumer, for example, a process or a transaction. A list of accepted values is defined in the lookup type ORA_HEY_CONSUMER_TYPE_CODE. -
dataGetterConsumerProfileMappings: array
Data Selection Tool Consumer Profile Mappings
Title:
Data Selection Tool Consumer Profile Mappings
The data selection tool consumer profile mappings resource provides a list of artifact data profiles mapped to a data selection tool consumer. -
dataGetterConsumerToolMappings: array
Data Selection Tool Consumer Tool Mappings
Title:
Data Selection Tool Consumer Tool Mappings
The data selection tool consumer tool mappings resource provides a list of selection tools mapped for a data selection tool consumer. -
DataProfileUsageTypeCode: string
Title:
Data Profile Usage Type Code
Maximum Length:30
Data profile usage type code that a data selection tool consumer has access to, for example, all profiles or consumer specific profiles. A list of accepted values is defined in the lookup type ORA_HEY_DATA_PROFILE_USE. -
DefaultQueryOwnershipFlag: boolean
Title:
Default Query Ownership
Maximum Length:1
Indicates if the data selection tool consumer can own a query by default or not. -
Description: string
Title:
Description
Maximum Length:240
Description of the data selection tool consumer. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReferenceAttributeName: string
Title:
Reference Attribute Name
Maximum Length:128
Data selection tool consumer source table attribute name in which query usage reference ID is stored. -
SelectAllColumnsFlag: boolean
Title:
Select All Columns
Maximum Length:1
Indicates if all columns of the view objects need to be selected by default or not in query creation UI flows. -
SourceTableName: string
Title:
Source Table Name
Maximum Length:128
Data selection tool consumer source table name. Used to scan for orphan query usage entries. These entries indicate queries for which usage is unknown.
Nested Schema : Data Selection Tool Consumer Profile Mappings
Type:
array
Title:
Data Selection Tool Consumer Profile Mappings
The data selection tool consumer profile mappings resource provides a list of artifact data profiles mapped to a data selection tool consumer.
Show Source
Nested Schema : Data Selection Tool Consumer Tool Mappings
Type:
array
Title:
Data Selection Tool Consumer Tool Mappings
The data selection tool consumer tool mappings resource provides a list of selection tools mapped for a data selection tool consumer.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : dataGetterConsumers-dataGetterConsumerProfileMappings-item-response
Type:
Show Source
object
-
ArtifactGroupId: integer
(int64)
Title:
Artifact Group ID
Data profile identifier associated with a data selection consumer and selection tool combination. Data profile is a type of data artifact group. -
ConsumerProfileMappingId: integer
(int64)
Title:
Consumer Profile Mapping ID
Data selection tool consumer profile mapping unique identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SelectionToolId: integer
(int64)
Title:
Selection Tool ID
Data selection tool unique identifier.
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 : dataGetterConsumers-dataGetterConsumerToolMappings-item-response
Type:
Show Source
object
-
ArtifactGroupTypeCode: string
Title:
Artifact Group Type Code
Read Only:true
Maximum Length:30
Artifact group type code that's associated with a data selection tool. -
ConsumerToolMappingId: integer
(int64)
Title:
Consumer Tool Mapping ID
Data selection tool consumer and tool mapping unique identifier. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SelectionToolCode: string
Title:
Selection Tool Code
Read Only:true
Maximum Length:30
Data selection tool unique code. -
SelectionToolId: integer
(int64)
Title:
Selection Tool ID
Data selection tool unique identifier. -
SelectionToolName: string
Title:
Selection Tool Name
Read Only:true
Maximum Length:100
Name of the data selection tool.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source