Update a data loader mapping
patch
/fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}/child/dataLoaderMappings/{LoaderMapId}
Request
Path Parameters
-
LoaderMapId(required): integer(int64)
The unique identifier for the import data load mapping attribute.
-
dataLoaderSettingsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Data Loader Settings resource and used to uniquely identify an instance of Data Loader Settings. The client should not generate the hash key value. Instead, the client should query on the Data Loader Settings collection resource in order to navigate to a specific instance of Data Loader Settings to get the hash key.
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
-
ChangesAllowedFlag: boolean
Title:
Allow Changes
Maximum Length:1
Default Value:true
Indicates if changes are allowed for this inbound data attribute. The default value of the attribute is 'true', which means changes are allowed. -
ColumnDisplayName: string
Title:
Column Name
Maximum Length:50
The name of the inbound attribute which is displayed as the column label on the user interface. -
ColumnLength: integer
(int32)
Title:
Imported Column Length
The length of the inbound file attribute. -
ColumnPositionStart: integer
(int32)
Title:
Imported Column Start Position or Sequence
The start position or overall sequence of the inbound attribute in the data file. -
ColumnRequiredFlag: boolean
Title:
Required
Maximum Length:1
Default Value:false
Indicates that data is required and expected for this inbound attribute. Used for validation of imported data. The default value of the attribute is 'false', which means a value is not required for the column. -
ColumnSequence: integer
(int32)
Title:
Sequence
The order of imported data attributes as presented on the user interface. -
ColumnStagingField: string
Title:
Staging Field
Maximum Length:30
The target column in the interface table to which the imported attribute is mapped. -
ColumnTypeCode: string
Title:
Column Type Code
Maximum Length:30
The desired data type of the imported attribute. Used for validation of imported data. A list of accepted values is defined in the lookup type ORA_HEY_LOADER_COLUMN_TYPE. -
ColumnUIFlag: boolean
Title:
Show Column
Maximum Length:1
Default Value:true
Indicates whether the column should be displayed on the user interface to provide information about the interface table row details. The default value of the attribute is 'true', which means the column should be displayed. -
ColumnUIHeadingFlag: boolean
Title:
Show Column in Heading
Maximum Length:1
Default Value:false
Indicates whether the column should be displayed as a data heading on the user interface to provide context and aid in identification of the row. The default value of the attribute is 'false', which means the column should not be displayed. -
ColumnUIHeadingSequence: integer
(int32)
Title:
Column Heading Sequence
The desired display order of data heading as presented on the user interface. -
TransformationRuleId: integer
(int64)
Title:
Transformation Rule ID
The identifier of the associated transformation rule that is used for transforming inbound attributes during the data validation process.
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 : dataLoaderSettings-dataLoaderMappings-item-response
Type:
Show Source
object
-
ChangesAllowedFlag: boolean
Title:
Allow Changes
Maximum Length:1
Default Value:true
Indicates if changes are allowed for this inbound data attribute. The default value of the attribute is 'true', which means changes are allowed. -
ColumnDisplayName: string
Title:
Column Name
Maximum Length:50
The name of the inbound attribute which is displayed as the column label on the user interface. -
ColumnLength: integer
(int32)
Title:
Imported Column Length
The length of the inbound file attribute. -
ColumnPositionStart: integer
(int32)
Title:
Imported Column Start Position or Sequence
The start position or overall sequence of the inbound attribute in the data file. -
ColumnRequiredFlag: boolean
Title:
Required
Maximum Length:1
Default Value:false
Indicates that data is required and expected for this inbound attribute. Used for validation of imported data. The default value of the attribute is 'false', which means a value is not required for the column. -
ColumnSequence: integer
(int32)
Title:
Sequence
The order of imported data attributes as presented on the user interface. -
ColumnStagingField: string
Title:
Staging Field
Maximum Length:30
The target column in the interface table to which the imported attribute is mapped. -
ColumnTypeCode: string
Title:
Column Type Code
Maximum Length:30
The desired data type of the imported attribute. Used for validation of imported data. A list of accepted values is defined in the lookup type ORA_HEY_LOADER_COLUMN_TYPE. -
ColumnTypeMeaning: string
Title:
Column Type
Read Only:true
Maximum Length:80
The meaning of the column type code. Examples of meanings are character and numeric. A list of accepted values is defined in the lookup type ORA_HEY_LOADER_COLUMN_TYPE. -
ColumnUIFlag: boolean
Title:
Show Column
Maximum Length:1
Default Value:true
Indicates whether the column should be displayed on the user interface to provide information about the interface table row details. The default value of the attribute is 'true', which means the column should be displayed. -
ColumnUIHeadingFlag: boolean
Title:
Show Column in Heading
Maximum Length:1
Default Value:false
Indicates whether the column should be displayed as a data heading on the user interface to provide context and aid in identification of the row. The default value of the attribute is 'false', which means the column should not be displayed. -
ColumnUIHeadingSequence: integer
(int32)
Title:
Column Heading Sequence
The desired display order of data heading as presented on the user interface. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LoaderMapId: integer
(int64)
Title:
Mapping ID
Read Only:true
The unique identifier for the import data load mapping attribute. -
SeedDataLock: integer
(int32)
Title:
Predefined Data Lock Value
Read Only:true
Default Value:0
Indicates whether the record is predefined. The value 0 means the record is not predefined. The value 1 means the record is predefined and cannot be updated. A value greater than 1 means the record is predefined but can be updated. -
TransformationRuleId: integer
(int64)
Title:
Transformation Rule ID
The identifier of the associated transformation rule that is used for transforming inbound attributes during the data validation process.
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.
Links
- loaderColumnTypeLOV
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DORA_HEY_LOADER_COLUMN_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: ColumnTypeCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: