Get a mapping set
get
/fscmRestApi/resources/11.13.18.05/attributeDerivationMappingSets/{MappingSetId}
Request
Path Parameters
-
MappingSetId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : attributeDerivationMappingSets-item-response
Type:
Show Source
object
-
ApplicationId: integer
(int64)
Default Value:
435
The unique identifier of the application associated with the mapping set. -
Description: string
Maximum Length:
240
A brief description of the mapping set. -
FilterMapSet: string
Read Only:
true
Maximum Length:255
A brief description of the mapping set. -
FunAdmMappingSetFlavor: array
Target Attribute Value Sets and Default Outputs
Title:
Target Attribute Value Sets and Default Outputs
The target attribute value sets and default outputs represent the chart of accounts or value sets assigned to mapping sets. You can create, update, delete, or view target attribute value sets and default output information used in the attribute derivation mapping set. -
FunAdmMappingSetInput: array
Input Sources
Title:
Input Sources
A mapping set input source represents a collection of input source that are used in the attribute derivation rule. You can create, update, delete, or view mapping set input sources information used in the attribute derivation rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingSetCode: string
Maximum Length:
30
Short name of mapping set. -
MappingSetId: integer
(int64)
The unique identifier of the mapping set.
-
Name: string
Maximum Length:
80
Name of the mapping set. -
NumberInputs: integer
(int64)
Number of source attributes assigned to the mapping set.
-
Source1: string
Read Only:
true
Maximum Length:255
The attribute value of the first input source. -
Source10: string
Read Only:
true
Maximum Length:255
The attribute value of the tenth input source. -
Source2: string
Read Only:
true
Maximum Length:255
The attribute value of the second input source. -
Source3: string
Read Only:
true
Maximum Length:255
The attribute value of the third input source. -
Source4: string
Read Only:
true
Maximum Length:255
The attribute value of the fourth input source. -
Source5: string
Read Only:
true
Maximum Length:255
The attribute value of the fifth input source. -
Source6: string
Read Only:
true
Maximum Length:255
The attribute value of the sixth input source. -
Source7: string
Read Only:
true
Maximum Length:255
The attribute value of the seventh input source. -
Source8: string
Read Only:
true
Maximum Length:255
The attribute value of the eighth input source. -
Source9: string
Read Only:
true
Maximum Length:255
The attribute value of the ninth input source.
Nested Schema : Target Attribute Value Sets and Default Outputs
Type:
array
Title:
Target Attribute Value Sets and Default Outputs
The target attribute value sets and default outputs represent the chart of accounts or value sets assigned to mapping sets. You can create, update, delete, or view target attribute value sets and default output information used in the attribute derivation mapping set.
Show Source
Nested Schema : Input Sources
Type:
array
Title:
Input Sources
A mapping set input source represents a collection of input source that are used in the attribute derivation rule. You can create, update, delete, or view mapping set input sources information used in the attribute derivation rule.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : attributeDerivationMappingSets-FunAdmMappingSetFlavor-item-response
Type:
Show Source
object
-
DefaultCcid: integer
(int64)
Default output value associated with a mapping set.
-
DefaultConstant: string
Maximum Length:
240
Default output value associated with a mapping set. -
FunAdmMappingSetValues: array
Mappings
Title:
Mappings
Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingSetCode: string
Maximum Length:
30
Short name of mapping set. -
MappingSetFlavorId: integer
(int64)
The unique identifier of the value set assignment.
-
StripeId: integer
(int64)
The unique identifier of the input source value set.
-
ValueSetCode: string
Read Only:
true
Maximum Length:255
Value set associated with the mapping set input source.
Nested Schema : Mappings
Type:
array
Title:
Mappings
Attribute derivation mapping involves identifying relationships between target values and each combination of input values for a mapping set. It maps the attributes from the input source to the target attribute, where the values in the target attributes are derived based on the data from the input source. You can create, update, delete, or view mappings information used in the attribute derivation mapping set.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : attributeDerivationMappingSets-FunAdmMappingSetFlavor-FunAdmMappingSetValues-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Effective end date of the mapping.
-
EffectiveStartDate: string
(date)
Effective start date of the mapping.
-
Enabled: string
Maximum Length:
1
Default Value:Y
Indicates whether the mapping is enabled. -
InputValueConstant1: string
Maximum Length:
240
The value of the first input source. -
InputValueConstant10: string
Maximum Length:
30
The value of the tenth input source. -
InputValueConstant2: string
Maximum Length:
240
The value of the second input source. -
InputValueConstant3: string
Maximum Length:
240
The value of the third input source. -
InputValueConstant4: string
Maximum Length:
30
The value of the fourth input source. -
InputValueConstant5: string
Maximum Length:
30
The value of the fifth input source. -
InputValueConstant6: string
Maximum Length:
30
The value of the sixth input source. -
InputValueConstant7: string
Maximum Length:
30
The value of the seventh input source. -
InputValueConstant8: string
Maximum Length:
30
The value of the eighth input source. -
InputValueConstant9: string
Maximum Length:
30
The value of the ninth input source. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingSetCode: string
Maximum Length:
30
Short name of mapping set. -
MappingSetFlavorId: integer
(int64)
The unique identifier of the value set assignment.
-
MappingSetValueId: integer
(int64)
The unique identifier of the mapping.
-
StripeId: integer
(int64)
The unique identifier of the input source value set.
-
TransactionCOAId: integer
(int64)
The unique identifier of the chart of account associated with the input source.
-
ValueCodeCombinationId: integer
(int64)
Code combination identifier associated with the output.
-
ValueConstant: string
Maximum Length:
240
Output value associated with a mapping when no default output is specified.
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 : attributeDerivationMappingSets-FunAdmMappingSetInput-item-response
Type:
Show Source
object
-
FlexSegment: string
Maximum Length:
30
The chart of accounts segment from the input source. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LookupType: string
Maximum Length:
30
Lookup type associated with the input source. -
MappingSetCode: string
Maximum Length:
30
Short name of mapping set. -
MappingSetInputId: integer
(int64)
The unique identifier of the mapping set input source.
-
SourceApplicationId: integer
(int64)
Application associated with the mapping set input source.
-
SourceCode: string
Maximum Length:
30
Short name of the mapping set input source. -
SourceOriginCode: string
Maximum Length:
1
Indicates whether the input source is predefined. -
SourceTypeCode: string
Maximum Length:
1
Type of source. -
ValueSetCode: string
Read Only:
true
Maximum Length:255
Value set associated with the mapping set input source. -
ValueSetId: integer
(int64)
Value set associated with the mapping set input source.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- FunAdmMappingSetFlavor
-
Parameters:
- MappingSetId:
$request.path.MappingSetId
The target attribute value sets and default outputs represent the chart of accounts or value sets assigned to mapping sets. You can create, update, delete, or view target attribute value sets and default output information used in the attribute derivation mapping set. - MappingSetId:
- FunAdmMappingSetInput
-
Parameters:
- MappingSetId:
$request.path.MappingSetId
A mapping set input source represents a collection of input source that are used in the attribute derivation rule. You can create, update, delete, or view mapping set input sources information used in the attribute derivation rule. - MappingSetId: