Update a mapping pair
patch
/fscmRestApi/resources/11.13.18.05/publicSectorMappingDetails/{publicSectorMappingDetailsUniqID}
Request
Path Parameters
-
publicSectorMappingDetailsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- MappingName and TransformId ---for the Mapping Details resource and used to uniquely identify an instance of Mapping Details. The client should not generate the hash key value. Instead, the client should query on the Mapping Details collection resource with a filter on the primary key values in order to navigate to a specific instance of Mapping Details.
For example: publicSectorMappingDetails?q=MappingName=<value1>;TransformId=<value2>
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
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.
Response
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 : publicSectorMappingDetails-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 : 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.