Get all customers
get
/fscmRestApi/resources/11.13.18.05/channelCustomerPrograms/{ProgramId}/child/customers
Request
Path Parameters
-
ProgramId(required): integer(int64)
Value that uniquely identifies the customer program.
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 -
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 customers according to the primary key.
Finder Variables:- RuleId; integer; Value that uniquely identifies the customers.
- PrimaryKey: Finds customers according to the 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:- AccountNumber; string; Number of the bill-to customer account.
- Address; string; Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site.
- ChildRuleNumber; integer; Number that identifies the trailing component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 5.2, then the rule number is 5 and the child rule number is 2. Validation: It must be an integer >= 0. It can't have a duplicate display line number.
- ComparisonOperatorCode; string; Abbreviation that identifies the comparison operator used in the customer.
- CreatedBy; string; User who created the record.
- CreationDate; string; Date and time when the user created the record.
- CustomQualifierFlag; boolean; Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false.
- Customer; string; Name of the customer.
- DomainDataTypeCode; string; Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES.
- DomainLookupTypeCode; string; Lookup type code for the dimension of the lookup domain type.
- DomainTypeCode; string; Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES.
- EndDate; string; Date when the customer is no longer applicable.
- LastUpdateDate; string; Date and time when the user most recently updated the record.
- LastUpdatedBy; string; User who most recently updated the record.
- MatrixDimensionId; integer; Value that uniquely identifies the dimension.
- ParentRuleId; integer; Value that identifies the parent customer.
- ProgramId; integer; Value that uniquely identifies the customer program.
- QualifierNumberValueCode; integer; Value of the numeric qualifier used in customer program qualification.
- QualifierType; string; Type of qualifier used to define the eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL.
- QualifierTypeCode; string; Abbreviation that identifies the type of qualifier used to define the eligibility of the customer program.
- QualifierValue; string; Name of the qualifier used in customer program qualification.
- QualifierValueCode; string; Abbreviation that identifies the qualifier used in customer program qualification.
- RuleId; integer; Value that uniquely identifies the customer. It's a primary key that the application generates when it creates the customer.
- RuleNumber; integer; Number that identifies the leading component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 3.1, then the rule number is 3 and the child rule number is 1. Validation: It must be an integer > 0. Cannot have duplicate display line number.
- Site; string; Name of the bill-to customer account site or the ship-to site.
- StartDate; string; Date when the customer becomes applicable.
-
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:
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.
Root Schema : channelCustomerPrograms-customers
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 : channelCustomerPrograms-customers-item-response
Type:
Show Source
object
-
AccountNumber: string
Read Only:
true
Maximum Length:255
Number of the bill-to customer account. -
Address: string
Read Only:
true
Maximum Length:255
Primary bill-to address for the customer or the address of the bill-to customer account site or the ship-to site. -
ChildRuleNumber: integer
(int32)
Number that identifies the trailing component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 5.2, then the rule number is 5 and the child rule number is 2. Validation: It must be an integer >= 0. It can't have a duplicate display line number.
-
ComparisonOperator: string
Maximum Length:
255
Name of the comparison operator used in the customer. A list of accepted values is defined in the lookup type ORA_CJM_QUALIFIER_OPERATOR. -
ComparisonOperatorCode: string
Maximum Length:
30
Abbreviation that identifies the comparison operator used in the customer. -
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the record. -
CreationDate: string
(date-time)
Read Only:
true
Date and time when the user created the record. -
Customer: string
Read Only:
true
Maximum Length:255
Name of the customer. -
CustomQualifierFlag: boolean
Read Only:
true
Contains one of the following values: true or false. If true, then it's a custom qualifier. If false, then it isn't a custom qualifier. The default value for this attribute is false. -
DomainDataTypeCode: string
Read Only:
true
Maximum Length:255
Type of dimension data. Valid values include text, number, date, and time stamp. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DATA_TYPES. -
DomainLookupTypeCode: string
Read Only:
true
Maximum Length:255
Lookup type code for the dimension of the lookup domain type. -
DomainTypeCode: string
Read Only:
true
Maximum Length:255
Type of domain. Valid values include lookup, view object query, and custom. A list of accepted values is defined in the lookup type ORA_QP_MTRXR_DIMN_DOMAIN_TYPES. -
EndDate: string
(date)
Date when the customer is no longer applicable.
-
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MatrixDimensionId: integer
Read Only:
true
Value that uniquely identifies the dimension. -
ParentRuleId: integer
(int64)
Value that identifies the parent customer.
-
ProgramId: integer
(int64)
Value that uniquely identifies the customer program.
-
QualifierNumberValueCode: integer
Read Only:
true
Value of the numeric qualifier used in customer program qualification. -
QualifierType: string
Maximum Length:
255
Type of qualifier used to define the eligibility of the customer program. A list of accepted values is defined in the lookup type ORA_CJM_CUST_REBATE_QUAL. -
QualifierTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of qualifier used to define the eligibility of the customer program. -
QualifierValue: string
Read Only:
true
Maximum Length:255
Name of the qualifier used in customer program qualification. -
QualifierValueCode: string
Maximum Length:
240
Abbreviation that identifies the qualifier used in customer program qualification. -
RuleId: integer
(int64)
Read Only:
true
Value that uniquely identifies the customer. It's a primary key that the application generates when it creates the customer. -
RuleNumber: integer
(int32)
Number that identifies the leading component of the display line number. The display line number is a concatenation of the rule number and the child rule number separated by a period. For example, if the display line number is 3.1, then the rule number is 3 and the child rule number is 1. Validation: It must be an integer > 0. Cannot have duplicate display line number.
-
Site: string
Read Only:
true
Maximum Length:255
Name of the bill-to customer account site or the ship-to site. -
StartDate: string
(date)
Date when the customer becomes applicable.
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.