Jump to

• Request
• Response

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 value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• 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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 isn't 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's used for transforming inbound attributes during the data validation process.

{
    "type":"object",
    "properties":{
        "ColumnDisplayName":{
            "title":"Column Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the inbound attribute which is displayed as the column label on the user interface.",
            "nullable":true
        },
        "ColumnStagingField":{
            "title":"Staging Field",
            "maxLength":"30",
            "type":"string",
            "description":"The target column in the interface table to which the imported attribute is mapped.",
            "nullable":true
        },
        "ColumnUIHeadingSequence":{
            "title":"Column Heading Sequence",
            "type":"integer",
            "description":"The desired display order of data heading as presented on the user interface.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "ColumnUIHeadingFlag":{
            "title":"Show Column in Heading",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false
        },
        "ColumnPositionStart":{
            "title":"Imported Column Start Position or Sequence",
            "type":"integer",
            "description":"The start position or overall sequence of the inbound attribute in the data file.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "ColumnRequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"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 isn't required for the column.",
            "nullable":false,
            "default":false
        },
        "ColumnLength":{
            "title":"Imported Column Length",
            "type":"integer",
            "description":"The length of the inbound file attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "TransformationRuleId":{
            "title":"Transformation Rule ID",
            "type":"integer",
            "description":"The identifier of the associated transformation rule that's used for transforming inbound attributes during the data validation process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChangesAllowedFlag":{
            "title":"Allow Changes",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if changes are allowed for this inbound data attribute. The default value of the attribute is true, which means changes are allowed.",
            "nullable":false,
            "default":true
        },
        "ColumnSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of imported data attributes as presented on the user interface.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            }
        },
        "ColumnTypeCode":{
            "title":"Column Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ColumnUIFlag":{
            "title":"Show Column",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":true
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : dataLoaderSettings-dataLoaderMappings-item-response

Type: object

Show Source

• 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 isn't 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 isn't predefined. The value 1 means the record is predefined and can't 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's used for transforming inbound attributes during the data validation process.

{
    "type":"object",
    "properties":{
        "ColumnTypeMeaning":{
            "title":"Column Type",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ColumnDisplayName":{
            "title":"Column Name",
            "maxLength":"50",
            "type":"string",
            "description":"The name of the inbound attribute which is displayed as the column label on the user interface.",
            "nullable":true,
            "x-queryable":true
        },
        "ColumnStagingField":{
            "title":"Staging Field",
            "maxLength":"30",
            "type":"string",
            "description":"The target column in the interface table to which the imported attribute is mapped.",
            "nullable":true,
            "x-queryable":true
        },
        "ColumnUIHeadingSequence":{
            "title":"Column Heading Sequence",
            "type":"integer",
            "description":"The desired display order of data heading as presented on the user interface.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "SeedDataLock":{
            "title":"Predefined Data Lock Value",
            "type":"integer",
            "description":"Indicates whether the record is predefined. The value 0 means the record isn't predefined. The value 1 means the record is predefined and can't be updated. A value greater than 1 means the record is predefined but can be updated.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ColumnUIHeadingFlag":{
            "title":"Show Column in Heading",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ColumnPositionStart":{
            "title":"Imported Column Start Position or Sequence",
            "type":"integer",
            "description":"The start position or overall sequence of the inbound attribute in the data file.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "LoaderMapId":{
            "title":"Mapping ID",
            "type":"integer",
            "description":"The unique identifier for the import data load mapping attribute.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ColumnRequiredFlag":{
            "title":"Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"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 isn't required for the column.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ColumnLength":{
            "title":"Imported Column Length",
            "type":"integer",
            "description":"The length of the inbound file attribute.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "TransformationRuleId":{
            "title":"Transformation Rule ID",
            "type":"integer",
            "description":"The identifier of the associated transformation rule that's used for transforming inbound attributes during the data validation process.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangesAllowedFlag":{
            "title":"Allow Changes",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if changes are allowed for this inbound data attribute. The default value of the attribute is true, which means changes are allowed.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ColumnSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of imported data attributes as presented on the user interface.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ColumnTypeCode":{
            "title":"Column Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ColumnUIFlag":{
            "title":"Show Column",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

loaderColumnTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

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

Back to Top