Get all mapping sets

get

/fscmRestApi/resources/11.13.18.05/attributeDerivationMappingSets

Request

Query Parameters
  • 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).
  • 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
  • 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 the mapping set with the specified primary key.
      Finder Variables
      • MappingSetId; integer; The unique identifier of the mapping set.
    • findByMapSetCode Finds the mappings with a specific mapping set code.
      Finder Variables
      • bindvarMapSetCode; string; Short name of the mapping set.
    • findBySources Finds the mappings with a specific mapping set code.
      Finder Variables
      • bindvarSrcList; string; Short name of the mapping set.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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:
    • ApplicationId; integer; The unique identifier of the application associated with the mapping set.
    • Description; string; A brief description of the mapping set.
    • FilterMapSet; string; A brief description of the mapping set.
    • MappingSetCode; string; Short name of mapping set.
    • MappingSetId; integer; The unique identifier of the mapping set.
    • Name; string; Name of the mapping set.
    • NumberInputs; integer; Number of source attributes assigned to the mapping set.
    • Source1; string; The attribute value of the first input source.
    • Source10; string; The attribute value of the tenth input source.
    • Source2; string; The attribute value of the second input source.
    • Source3; string; The attribute value of the third input source.
    • Source4; string; The attribute value of the fourth input source.
    • Source5; string; The attribute value of the fifth input source.
    • Source6; string; The attribute value of the sixth input source.
    • Source7; string; The attribute value of the seventh input source.
    • Source8; string; The attribute value of the eighth input source.
    • Source9; string; The attribute value of the ninth input source.
  • 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
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : attributeDerivationMappingSets
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : attributeDerivationMappingSets-item-response
Type: object
Show 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 : attributeDerivationMappingSets-FunAdmMappingSetFlavor-item-response
Type: object
Show 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 : attributeDerivationMappingSets-FunAdmMappingSetFlavor-FunAdmMappingSetValues-item-response
Type: object
Show Source
Nested Schema : attributeDerivationMappingSets-FunAdmMappingSetInput-item-response
Type: object
Show Source
Back to Top