Jump to

• Request
• Response

Get a data loader setting

get

/fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}

Request

Path Parameters

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

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 Top

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.

Body ()

Root Schema : dataLoaderSettings-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Indicates whether the data load setting record is active or inactive. The default value of the attribute is 'true' which means active.
• dataLoaderMappings: array Data Loader Mappings
  Title: Data Loader Mappings

  Use the data loader mappings resource to view, create, or modify the mapping information. This mapping information indicates how data coming in from the external file should be mapped to the interface and production application tables.
• Description: string
  Title: Description

  The description of the import data load settings.
• FileTypeCode: string
  Title: File Type Code

  Maximum Length: 30

  Default Value: ORA_CSV

  The type of file being set up for processing by the import data load process. The default value of the attribute is 'ORA_CSV'. A list of accepted values is defined in the lookup type ORA_HEY_LOADER_FILE_TYPE.
• FileTypeMeaning: string
  Title: File Type

  Read Only: true

  Maximum Length: 80

  The meaning of the file type code. An example of a meaning is comma delimited. A list of accepted values is defined in the lookup type ORA_HEY_LOADER_FILE_TYPE.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoaderCode: string
  Title: Code

  Maximum Length: 30

  The alternate identifier for the import data load settings.
• LoaderId: integer (int64)
  Title: Data Loader ID

  Read Only: true

  The unique identifier for the import data load settings.
• LoaderName: string
  Title: Name

  Maximum Length: 50

  The name of the import data load settings.
• 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.

{
    "type":"object",
    "properties":{
        "LoaderName":{
            "title":"Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the import data load settings.",
            "nullable":false,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "type":"string",
            "description":"The description of the import data load settings.",
            "nullable":true,
            "x-queryable":true
        },
        "dataLoaderMappings":{
            "title":"Data Loader Mappings",
            "type":"array",
            "description":"Use the data loader mappings resource to view, create, or modify the mapping information. This mapping information indicates how data coming in from the external file should be mapped to the interface and production application tables.",
            "items":{
                "$ref":"#/components/schemas/dataLoaderSettings-dataLoaderMappings-item-response"
            }
        },
        "SeedDataLock":{
            "title":"Predefined Data Lock Value",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "FileTypeMeaning":{
            "title":"File Type",
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the file type code. An example of a meaning is comma delimited. A list of accepted values is defined in the lookup type ORA_HEY_LOADER_FILE_TYPE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LoaderCode":{
            "title":"Code",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier for the import data load settings.",
            "nullable":false,
            "x-queryable":true
        },
        "LoaderId":{
            "title":"Data Loader ID",
            "type":"integer",
            "description":"The unique identifier for the import data load settings.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the data load setting record is active or inactive. The default value of the attribute is 'true' which means active.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "FileTypeCode":{
            "title":"File Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The type of file being set up for processing by the import data load process. The default value of the attribute is 'ORA_CSV'. A list of accepted values is defined in the lookup type ORA_HEY_LOADER_FILE_TYPE.",
            "nullable":false,
            "default":"ORA_CSV",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Data Loader Mappings

Type: array

Title: Data Loader Mappings

Use the data loader mappings resource to view, create, or modify the mapping information. This mapping information indicates how data coming in from the external file should be mapped to the interface and production application tables.

Show Source

• Array of: object dataLoaderSettings-dataLoaderMappings-item-response

{
    "title":"Data Loader Mappings",
    "type":"array",
    "description":"Use the data loader mappings resource to view, create, or modify the mapping information. This mapping information indicates how data coming in from the external file should be mapped to the interface and production application tables.",
    "items":{
        "$ref":"#/components/schemas/dataLoaderSettings-dataLoaderMappings-item-response"
    }
}

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

{
    "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 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.",
            "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 is not 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 is 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

dataLoaderMappings

Operation: /fscmRestApi/resources/11.13.18.05/dataLoaderSettings/{dataLoaderSettingsUniqID}/child/dataLoaderMappings

Parameters:

• dataLoaderSettingsUniqID: $request.path.dataLoaderSettingsUniqID

Use the data loader mappings resource to view, create, or modify the mapping information. This mapping information indicates how data coming in from the external file should be mapped to the interface and production application tables.

loaderFileTypeLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_LOADER_FILE_TYPE

The following properties are defined on the LOV link relation:

• Source Attribute: FileTypeCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top