Jump to

• Request
• Response

Get a staging header

get

/fscmRestApi/resources/11.13.18.05/dataLoaderStagingHeaders/{LoadRequestId}

Request

Path Parameters

• LoadRequestId(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=

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 : dataLoaderStagingHeaders-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates who created a data loader common staging header.
• FileName: string
  Title: File Name

  Maximum Length: 250

  The name of the file being processed or imported.
• FileTypeCode: string
  Title: File Type Code

  Read Only: true

  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.
• InitialLoadDateTime: string (date-time)
  Title: Load Date Time

  The date and time of the initial data load.
• LastModifiedDate: string (date-time)
  Read Only: true

  The date and time of the last modification.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoadCategoryCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: ORA_ADMISSIONS

  The type of load that's being set up for processing by the import data load process. The default value of the attribute is ORA_ADMISSIONS_COMMON_APP. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_CATEGORY_CODE.
• LoadCategoryMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the load category code. An example of a meaning is the admissions common application load. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_CATEGORY_CODE.
• LoaderCode: string
  Title: Loader Code

  Read Only: true

  Maximum Length: 30

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

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

  Read Only: true

  Maximum Length: 50

  The name of the data loader settings.
• LoadRequestId: integer (int64)
  Title: Load Request ID

  The unique identifier for each file load. The import process populates this identifier.
• LoadStageCode: string
  Read Only: true

  Maximum Length: 30

  The stage code of the load. The default value of the attribute is ORA_INITIAL. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_STAGE.
• LoadStageMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the load stage code.
• LoadStatusCode: string
  Title: Load Status Code

  Read Only: true

  Maximum Length: 30

  Default Value: ORA_STAGED

  The status code of the load. The default value of the attribute is ORA_NEW. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_STATUS_CODE.
• LoadStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the load status code. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_STATUS_CODE.
• ProcessingCode: string
  Read Only: true

  Processing code that's used to process the load to the other stage. List of accepted values are PROCESS, IGNORE.
• statistics: array Data Loader Statistics
  Title: Data Loader Statistics

  Use the data loader statistics resource to view the statistics of the data import process.

{
    "type":"object",
    "properties":{
        "LoaderName":{
            "title":"Loader Name",
            "maxLength":50,
            "type":"string",
            "description":"The name of the data loader settings.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastModifiedDate":{
            "type":"string",
            "description":"The date and time of the last modification.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates who created a data loader common staging header.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoadCategoryCode":{
            "maxLength":30,
            "type":"string",
            "description":"The type of load that's being set up for processing by the import data load process. The default value of the attribute is ORA_ADMISSIONS_COMMON_APP. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_CATEGORY_CODE.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_ADMISSIONS",
            "x-queryable":true
        },
        "InitialLoadDateTime":{
            "title":"Load Date Time",
            "type":"string",
            "description":"The date and time of the initial data load.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the file being processed or imported.",
            "nullable":true,
            "x-queryable":true
        },
        "LoadStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the load status code. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_STATUS_CODE.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingCode":{
            "type":"string",
            "description":"Processing code that's used to process the load to the other stage. List of accepted values are PROCESS, IGNORE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LoaderId":{
            "title":"Data Loader ID",
            "type":"integer",
            "description":"The unique identifier for the import data load settings.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LoadStageCode":{
            "maxLength":30,
            "type":"string",
            "description":"The stage code of the load. The default value of the attribute is ORA_INITIAL. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_STAGE.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LoadRequestId":{
            "title":"Load Request ID",
            "type":"integer",
            "description":"The unique identifier for each file load. The import process populates this identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"false"
            },
            "x-queryable":true
        },
        "LoadCategoryMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the load category code. An example of a meaning is the admissions common application load. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_CATEGORY_CODE.",
            "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":"Loader Code",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier for the import data load settings.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoadStatusCode":{
            "title":"Load Status Code",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the load. The default value of the attribute is ORA_NEW. A list of accepted values is defined in the lookup type ORA_HEY_LOAD_STATUS_CODE.",
            "nullable":true,
            "readOnly":true,
            "default":"ORA_STAGED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LoadStageMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the load stage code.",
            "nullable":false,
            "readOnly":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,
            "readOnly":true,
            "default":"ORA_CSV",
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "statistics":{
            "title":"Data Loader Statistics",
            "type":"array",
            "description":"Use the data loader statistics resource to view the statistics of the data import process.",
            "items":{
                "$ref":"#/components/schemas/dataLoaderStagingHeaders-statistics-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 : Data Loader Statistics

Type: array

Title: Data Loader Statistics

Use the data loader statistics resource to view the statistics of the data import process.

Show Source

• Array of: object dataLoaderStagingHeaders-statistics-item-response

{
    "title":"Data Loader Statistics",
    "type":"array",
    "description":"Use the data loader statistics resource to view the statistics of the data import process.",
    "items":{
        "$ref":"#/components/schemas/dataLoaderStagingHeaders-statistics-item-response"
    }
}

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."
        }
    }
}

Nested Schema : dataLoaderStagingHeaders-statistics-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoadStatisticCode: string
  Maximum Length: 30

  The code of the statistic from the import process. A list of accepted values is defined in the lookup type ORA_HEY_STAGING_STATISTICS.
• LoadStatisticInteger: integer (int32)
  The value of the data import process statistic.
• LoadStatisticMeaning: string
  Read Only: true

  Maximum Length: 80

  The meaning of the load statistic code. An example of a meaning is number of unprocessed rows. A list of accepted values is defined in the lookup type ORA_HEY_STAGING_STATISTICS.
• LoadStatisticsId: integer (int64)
  The unique identifier for the data loader statistic table.

{
    "type":"object",
    "properties":{
        "LoadStatisticCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code of the statistic from the import process. A list of accepted values is defined in the lookup type ORA_HEY_STAGING_STATISTICS.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LoadStatisticMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The meaning of the load statistic code. An example of a meaning is number of unprocessed rows. A list of accepted values is defined in the lookup type ORA_HEY_STAGING_STATISTICS.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LoadStatisticInteger":{
            "type":"integer",
            "description":"The value of the data import process statistic.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "LoadStatisticsId":{
            "type":"integer",
            "description":"The unique identifier for the data loader statistic table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"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"
    }
}

Links

loadStageLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_HEY_LOAD_STAGE

The following properties are defined on the LOV link relation:

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

loadStatusLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: LookupTypeIsActiveEnabledFinder%3BLookupType%3DORA_HEY_LOAD_STATUS_CODE

The following properties are defined on the LOV link relation:

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

statistics

Operation: /fscmRestApi/resources/11.13.18.05/dataLoaderStagingHeaders/{LoadRequestId}/child/statistics

Parameters:

• LoadRequestId: $request.path.LoadRequestId

Use the data loader statistics resource to view the statistics of the data import process.

Back to Top