Update a mapping target
patch
/fscmRestApi/resources/11.13.18.05/publicSectorMappingTargets/{publicSectorMappingTargetsUniqID}
Request
Path Parameters
-
publicSectorMappingTargetsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- MappingName and TargetType ---for the Mapping Targets resource and used to uniquely identify an instance of Mapping Targets. The client should not generate the hash key value. Instead, the client should query on the Mapping Targets collection resource with a filter on the primary key values in order to navigate to a specific instance of Mapping Targets.
For example: publicSectorMappingTargets?q=MappingName=<value1>;TargetType=<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
-
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. -
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.
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 : publicSectorMappingTargets-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
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.