Get a mapping header definition
get
/fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}
Request
Path Parameters
-
MappingName(required): string
The unique name for the mapping. This name will be the parent key of all the children tables. Mandatory user defined field.
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(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 : publicSectorMappingHeaders-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Default Value:
1
The unique identifier of the agency associated with the mapping. Mandatory field that is system generated. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the mapping. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the mapping was created. -
DeletedFlag: string
Maximum Length:
1
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
Description: string
Title:
Description
Maximum Length:128
The description of the mapping. Mandatory user defined field. -
Enabled: string
Title:
Enabled
Maximum Length:1
Indicates whether the mapping is complete and available for use. The default value is false. Mandatory user defined field. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the mapping was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the mapping. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingDetail: array
Mapping Details
Title:
Mapping Details
The mapping details resources is used to store the mapping pairs between the source and the target. -
MappingName: string
Title:
Mapping Name
Maximum Length:50
The unique name for the mapping. This name will be the parent key of all the children tables. Mandatory user defined field. - MappingNavigator: array Mapping Navigators
-
MappingSource: array
Mapping Sources
Title:
Mapping Sources
The mapping sources resource is used to store the defination of the source for Data Format Exchange. -
MappingTarget: array
Mapping Targets
Title:
Mapping Targets
The mapping targets resource is used to store the definition of the target for Data Format Exchange. -
MappingXml: string
(byte)
The mapping XML string (XSLT) used in the transfer framework. System-generated when mapping list is ready.
-
ModuleId: string
Maximum Length:
32
The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data. -
SeedDataLock: integer
(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
SourceType: string
Title:
Source Type
Maximum Length:30
Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field. -
TargetType: string
Title:
Target Type
Maximum Length:30
Indicates the format of the target data specified in the mapping. For example, CSV. Mandatory user defined field.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Mapping Details
Type:
array
Title:
Mapping Details
The mapping details resources is used to store the mapping pairs between the source and the target.
Show Source
Nested Schema : Mapping Sources
Type:
array
Title:
Mapping Sources
The mapping sources resource is used to store the defination of the source for Data Format Exchange.
Show Source
Nested Schema : Mapping Targets
Type:
array
Title:
Mapping Targets
The mapping targets resource is used to store the definition of the target for Data Format Exchange.
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 : publicSectorMappingHeaders-MappingDetail-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the field transformation. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the field transformation was created. -
DeletedFlag: string
Maximum Length:
1
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the field transformation was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the field transformation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingName: string
Title:
Mapping Name
Maximum Length:50
The unique name for the mapping. Mandatory user defined field. -
ModuleId: string
Maximum Length:
32
Used by the Seed Data Framework to indicate the module that owns the row. A module is an entry in Application Taxonomy such as a Logical Business Area. When the MODULE_ID column exists and the owner of the row is not specified, the Seed Data Framework will not extract the row as seed data. -
SeedDataLock: integer
(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
SeedDataSource: string
Maximum Length:
512
Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file. -
SourceColumnName: string
Title:
Source Field
Maximum Length:50
The field whose value is mapped to the corresponding target field. User defined field. -
TargetColumnName: string
Title:
Target Field
Maximum Length:50
The field containing the result of the field transformation. Mandatory system generated field. -
TransformId: integer
(int64)
The unique identifier of the source to target field transformation. Value is mandatory and is system-generated after the target file is specified.
-
TransformParameter: string
Title:
Transform Parameter
Maximum Length:50
The parameter used to determine the value of the target field. User defined field. For example, if the target field is Effective Date and the Transform option is Constant, the Transform Parameter might be 01/01/2018. -
TransformType: string
Title:
Transform
Maximum Length:30
The type of transformation applied to the target field. User defined field. For example, Constant.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorMappingHeaders-MappingSource-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the field transformation. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the field transformation was created. -
CsvTemplate: string
(byte)
The CSV file specified by the user that contains the source fields referenced in the data mapping, stored in an alternative field format required for further processing.
-
DeletedFlag: string
Maximum Length:
1
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
FieldDelimiter: string
Maximum Length:
10
The character that separates each field in the source file. For example, a comma. -
Iszipped: string
Maximum Length:
1
Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the field transformation was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the field transformation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingName: string
Title:
Mapping Name
Maximum Length:50
The unique name for the mapping. Mandatory user defined field. -
ModuleId: string
Maximum Length:
32
The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data. -
RecordDelimiter: string
Maximum Length:
10
The characters that separate each row of data in the source file. For example, 'END'. -
RestSoapEndpoint: string
Maximum Length:
128
The endpoint of a REST or SOAP service. Mandatory system generated field. -
SeedDataLock: integer
(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
SeedDataSource: string
Maximum Length:
512
Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file. -
SourceType: string
Title:
Source Type
Maximum Length:30
Indicates the format of the source data specified in the mapping. For example, VO. Mandatory user defined field. -
TemplateFileName: string
Maximum Length:
50
The CSV file specified by the user that contains the source fields referenced in the data mapping. -
Vo: string
Title:
Source Name
Maximum Length:50
The source view to be included in the data mapping. Mandatory user defined field.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorMappingHeaders-MappingTarget-item-response
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the field transformation. -
CreationDate: string
(date-time)
Read Only:
true
The date and time when the field transformation was created. -
CsvTemplate: string
(byte)
The CSV file specified by the user that will be updated with the results of the field mapping, stored in an alternative field format required for further processing.
-
DeletedFlag: string
Maximum Length:
1
Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N. -
FieldDelimiter: string
Maximum Length:
10
The character that separates each field in the target file. For example, a comma. -
GeneratedFileName: string
Maximum Length:
50
The system generated name of the output file. -
Iszipped: string
Maximum Length:
1
Indicates whether the source file is in a zipped format. Valid values are Y for zipped, N for not zipped. Default value is N. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date and time when the field transformation was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the field transformation. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingName: string
Title:
Mapping Name
Maximum Length:50
Unique name for the mapping. Mandatory user defined field. -
ModuleId: string
Maximum Length:
32
The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data. -
RecordDelimiter: string
Maximum Length:
10
The characters that separate each row of data in the target file. For example, 'END'. -
RestSoapEndpoint: string
Maximum Length:
128
The endpoint of a REST or SOAP service. Mandatory system generated field. -
SeedDataLock: integer
(int32)
Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.
-
SeedDataSource: string
Maximum Length:
20
Used by the Seed Data Framework to indicate the source of seed data record. A value of 'BULK_SEED_DATA_SCRIPT' indicates that the record was bulk loaded. Otherwise, specifies the name of the seed data file. -
TargetType: string
Title:
Target Type
Maximum Length:30
Indicates the format of the target data specified in the mapping. For example, VO. Mandatory user defined field. -
TemplateFileName: string
Maximum Length:
50
The CSV file specified by the user that will be updated with the results of the field mapping. This is also the name referred to in UCM. -
Vo: string
Maximum Length:
50
The target view specified by the user that will be updated with the results of the field mapping.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- MappingDetail
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingDetailParameters:
- MappingName:
$request.path.MappingName
The mapping details resources is used to store the mapping pairs between the source and the target. - MappingName:
- MappingNavigator
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingNavigatorParameters:
- MappingName:
$request.path.MappingName
The mapping navigators resource is used to store the status of the setup wizard. - MappingName:
- MappingSource
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingSourceParameters:
- MappingName:
$request.path.MappingName
The mapping sources resource is used to store the defination of the source for Data Format Exchange. - MappingName:
- MappingTarget
-
Operation: /fscmRestApi/resources/11.13.18.05/publicSectorMappingHeaders/{MappingName}/child/MappingTargetParameters:
- MappingName:
$request.path.MappingName
The mapping targets resource is used to store the definition of the target for Data Format Exchange. - MappingName: