Get all settings
get
/fscmRestApi/resources/11.13.18.05/channelSettings
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: Find channel settings according to the primary key.
Finder Variables:- SettingId; integer; Value that uniquely identifies the channel setting.
- PrimaryKey: Find channel settings 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:- Category; string; Name of the category to which the channel setting belongs.
- CreatedBy; string; User who created the record.
- CreationDate; string; Date and time when the user created the record.
- Description; string; Description of the channel setting.
- LastUpdateDate; string; Login that the user used when updating the record.
- LastUpdatedBy; string; User who most recently updated the record.
- Name; string; Name of the channel setting.
- RequiredTask; string; Contains one of the following values: true or false. If true, then the channel setting setup is mandatory. If false, then the channel setting setup is not mandatory.
- SettingCode; string; Abbreviation that identifies the channel setting.
- SettingId; integer; Value that uniquely identifies the channel setting. It is a primary key that the application generates when it creates the channel setting.
- SettingLevel; string; Name of the level at which the channel setting is defined. Valid values are Site and Business Unit.
- SettingLevelCode; string; Abbreviation that identifies the level at which the channel setting is defined. Valid values are SITE and BUSINESS_UNIT.
-
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 : channelSettings
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 : channelSettings-item-response
Type:
Show Source
object
-
Category: string
Read Only:
true
Maximum Length:120
Name of the category to which the channel setting belongs. -
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. -
Description: string
Maximum Length:
1000
Description of the channel setting. -
LastUpdateDate: string
(date-time)
Read Only:
true
Login that the user used when updating 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. -
Name: string
Read Only:
true
Maximum Length:120
Name of the channel setting. -
RequiredTask: string
Read Only:
true
Maximum Length:1
Contains one of the following values: true or false. If true, then the channel setting setup is mandatory. If false, then the channel setting setup is not mandatory. -
SettingCode: string
Maximum Length:
30
Abbreviation that identifies the channel setting. -
SettingId: integer
(int64)
Value that uniquely identifies the channel setting. It is a primary key that the application generates when it creates the channel setting.
-
SettingLevel: string
Read Only:
true
Maximum Length:30
Name of the level at which the channel setting is defined. Valid values are Site and Business Unit. -
SettingLevelCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the level at which the channel setting is defined. Valid values are SITE and BUSINESS_UNIT. -
Values: array
Values
Title:
Values
The Values resource manages channel setting values.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Values
Type:
array
Title:
Values
The Values resource manages channel setting values.
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 : channelSettings-Values-item-response
Type:
Show Source
object
-
BusinessUnit: string
Name of the business unit.
-
BusinessUnitId: integer
(int64)
Value that uniquely identifies the business unit.
-
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. -
EnabledFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the channel setting value is enabled. If false, then the channel setting value is disabled. The default value is true. -
LastUpdateDate: string
(date-time)
Read Only:
true
Login that the user used when updating the record. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who most recently updated the record. -
LedgerCurrency: string
Maximum Length:
4000
Name of the ledger currency. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SettingId: integer
(int64)
Value that uniquely identifies the channel setting.
-
SettingValueId: integer
(int64)
Value that uniquely identifies the channel setting value. It is a primary key that the application generates when it creates the channel setting value.
-
Value: string
Name of the value of the channel setting entered by the user.
-
ValueCode: string
Maximum Length:
240
Abbreviation that identifies the channel setting value. -
ValueId: string
Value that uniquely identifies the channel setting value entered by the user.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
This example describes how to get all settings.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/channelSettings"
Example Response Body
The following shows an example of the response body in JSON format.
{ "items": [ { "SettingId": 300100209965420, "SettingCode": "CLAIM_OWNER_CODE", "Name": "Claim Owner", "Description": "The claim owner to be assigned at claim creation. Can be overridden at lower levels.", "Category": "Assignment", "SettingLevelCode": "BUSINESS_UNIT", "SettingLevel": "Business Unit", "RequiredTask": "N", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2020-08-03T20:43:04+00:00", "LastUpdateDate": "2020-08-03T20:43:04.167+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965420", "name": "channelSettings", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965420", "name": "channelSettings", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965420/child/Values", "name": "Values", "kind": "collection" } ] }, { "SettingId": 300100209965422, "SettingCode": "RECV_ACTIVITY_CODE", "Name": "Receivables Activity for Write-Off Adjustment", "Description": "Receivables activity used when creating write-Off adjustments for invoice related deductions.", "Category": "Settlement by Write-off", "SettingLevelCode": "BUSINESS_UNIT", "SettingLevel": "Business Unit", "RequiredTask": "Y", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2020-08-03T20:43:04.411+00:00", "LastUpdateDate": "2020-09-29T19:52:29+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965422", "name": "channelSettings", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965422", "name": "channelSettings", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965422/child/Values", "name": "Values", "kind": "collection" } ] }, { "SettingId": 300100209965423, "SettingCode": "DED_THRESHOLD_CODE", "Name": "Deduction Threshold", "Description": "Threshold for deduction claims.", "Category": "Settlement by Write-off", "SettingLevelCode": "BUSINESS_UNIT", "SettingLevel": "Business Unit", "RequiredTask": "Y", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2020-08-03T20:43:04.426+00:00", "LastUpdateDate": "2020-09-29T19:52:29.266+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965423", "name": "channelSettings", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965423", "name": "channelSettings", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965423/child/Values", "name": "Values", "kind": "collection" } ] }, { "SettingId": 300100209965424, "SettingCode": "AGING_METHOD_FILT_CODE", "Name": "Aging Method for Filtering", "Description": "Aging method used to filter claims. Aging method must belong to the Common Set.", "Category": "Manage Claims", "SettingLevelCode": "SITE", "SettingLevel": "Site", "RequiredTask": "Y", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2020-08-03T20:43:04.451+00:00", "LastUpdateDate": "2020-09-29T19:52:29.285+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965424", "name": "channelSettings", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965424", "name": "channelSettings", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100209965424/child/Values", "name": "Values", "kind": "collection" } ] }, { "SettingId": 300100210201566, "SettingCode": "CM_INV_CR_MTHD_ACCT_RULES", "Name": "Credit Method for Accounting Rules", "Description": "Specify the Receivables method to reverse accounting entries for the settlement method Credit Memo - On Invoice, if accounting rules are used in the original invoice.", "Category": "Settlement by Credit Memo - On Invoice", "SettingLevelCode": "SITE", "SettingLevel": "Site", "RequiredTask": "Y", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2020-09-29T19:52:29.041+00:00", "LastUpdateDate": "2020-09-29T19:52:29.188+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201566", "name": "channelSettings", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201566", "name": "channelSettings", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201566/child/Values", "name": "Values", "kind": "collection" } ] }, { "SettingId": 300100210201567, "SettingCode": "CM_INV_CR_MTHD_INSTLMENTS", "Name": "Credit Method for Installments", "Description": "Specify the Receivables method to credit installments for the settlement method Credit Memo - On Invoice, if multiple installments are used in the original invoice.", "Category": "Settlement by Credit Memo - On Invoice", "SettingLevelCode": "SITE", "SettingLevel": "Site", "RequiredTask": "Y", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2020-09-29T19:52:29.206+00:00", "LastUpdateDate": "2020-09-29T19:52:29.217+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201567", "name": "channelSettings", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201567", "name": "channelSettings", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201567/child/Values", "name": "Values", "kind": "collection" } ] }, { "SettingId": 300100210201568, "SettingCode": "WO_NONINV_DED_AR_ACTIVITY", "Name": "Receivables Activity for Receipt Write-Offs", "Description": "Receivables activity used when creating receipt write-offs for non-invoice related deduction.", "Category": "Settlement by Write-off", "SettingLevelCode": "BUSINESS_UNIT", "SettingLevel": "Business Unit", "RequiredTask": "Y", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2020-09-29T19:52:29.224+00:00", "LastUpdateDate": "2020-09-29T19:52:29.233+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201568", "name": "channelSettings", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201568", "name": "channelSettings", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201568/child/Values", "name": "Values", "kind": "collection" } ] }, { "SettingId": 300100210201569, "SettingCode": "WO_DEFAULT_REVIEWER", "Name": "Write-off Reviewer", "Description": "Claim owner assigned to review write-offs.", "Category": "Settlement by Write-off", "SettingLevelCode": "BUSINESS_UNIT", "SettingLevel": "Business Unit", "RequiredTask": "N", "CreatedBy": "SEED_DATA_FROM_APPLICATION", "CreationDate": "2020-09-29T19:52:29.244+00:00", "LastUpdateDate": "2020-09-29T19:52:29.251+00:00", "LastUpdatedBy": "SEED_DATA_FROM_APPLICATION", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201569", "name": "channelSettings", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201569", "name": "channelSettings", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/channelSettings/300100210201569/child/Values", "name": "Values", "kind": "collection" } ] } ], "count": 8, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/channelSettings", "name": "channelSettings", "kind": "collection" } ] }