Get a bulk export activity

get

/crmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : bulkExportActivities-item-response
Type: object
Show Source
  • Title: Activate
    Default Value: NO
    The attribute that specifies whether to activate the export job or not. Once activated a job is queued for execution.
  • Export Attachments
    Title: Export Attachments
    The attachment resource is used to export attachments for an object.
  • Title: Export Job Identifier
    The unique identifier of the export job.
  • Used for canceling an export job through REST
  • Read Only: true
    Indicates User who canceled export job
  • Export Child Object Activities
    Title: Export Child Object Activities
    The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Read Only: true
    Specifies current logged in user
  • Title: Date Format
    Maximum Length: 120
    Default Value: ORA_ZCA_US_FORMAT
    The format of the date values in the exported file.
  • Title: Delimiter
    Maximum Length: 30
    Default Value: COMMA_DELIMITER
    The delimiter used for the exported file.
  • Title: Description
    Maximum Length: 250
    The description for the export job that is provided by the user.
  • Title: Export attachments
    Maximum Length: 20
    Default Value: NO
    Enables export of Attachments
  • Title: Enable Split
    Maximum Length: 20
    Default Value: NO
    Specifies if the export file should be split into multiple files. Select YES to split the export data set based on a specified record count. The default is NO.
  • Title: End Time
    Read Only: true
    The time at which the export job ends.
  • Read Only: true
    The contents of the attached export error file.
  • Title: Error File URL
    The URL used for downloading the error file in a browser. For programmatic download of the error file zip file contents, follow the /enclosure/ErrorReportFileContents link.
  • Title: Escape Special Characters
    Indicates whether to exclude any special characters like quotes, delimiter, new line and so on. The default value is false.
  • Title: Export Column Names
    The object columns that are exported.
  • Read Only: true
    The contents of the attached export file.
  • Title: Export File Name
    Maximum Length: 250
    The name of the exported file that is uploaded to the file repository.
  • Title: Export File URL
    The URL used for downloading the export file in a browser. For programmatic download of the exported zip file contents, follow the /enclosure/ExportFileContents link.
  • Title: Export Filter Criteria
    Maximum Length: 4000
    The export object filter criteria specifying which records will be exported.
  • Title: Export Mapping
    A previously defined object filter criteria and mapping which specifies the list of records that will be exported.
  • Title: Object Code
    Maximum Length: 128
    The name of the object that is exported.
  • Title: Order By
    Maximum Length: 1000
    The order of the columns in the exported file.
  • Title: File Encoding
    Maximum Length: 30
    Default Value: ORA_ZCA_UTF8_ENCODING
    The format in which the characters within your export file are encoded.
  • Title: Enable Round Trip
    The language independent header for the exported file that is used to enable the round trip of job and automatic mapping.
  • Title: Last Update Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Name
    Maximum Length: 100
    The name provided for each individual export job.
  • Title: Note Object
    The Export Object Code for which Note has to be exported.
  • Title: Notification Email
    Maximum Length: 500
    The email ID to which the export job status emails are sent.
  • Private maps are persistant and can only be viewed or deleted by the owner.
  • Title: Records Exported
    Read Only: true
    The total number of records exported.
  • Specifies the REST Endpoint name, to which the notification will be sent after completion of the export job.
  • Title: Split Size
    Specifies the split size when split is enabled. You can specify the split size in multiples of 100000 records. The default value is 100000.
  • Title: Start Time
    Read Only: true
    The time at which the export job begins.
  • Title: Status
    Maximum Length: 30
    Default Value: NEW
    The status of the export job.
  • Title: Time Stamp Format
    Maximum Length: 120
    Default Value: ORA_ZCA_US_FORMAT
    The format of the time stamp values in the exported file.
Nested Schema : Export Attachments
Type: array
Title: Export Attachments
The attachment resource is used to export attachments for an object.
Show Source
Nested Schema : Export Child Object Activities
Type: array
Title: Export Child Object Activities
The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.
Show Source
Nested Schema : bulkExportActivities-Attachments-item-response
Type: object
Show Source
Nested Schema : bulkExportActivities-childBulkExportActivity-item-response
Type: object
Show Source
Nested Schema : Export Child Object Activities
Type: array
Title: Export Child Object Activities
The export child object activities resource is used to view, create, and update the large volumes of the child object data from target tables. The child bulk export activity resource can also be used to export hierarchy trees with multiple levels.
Show Source
Nested Schema : bulkExportActivities-childBulkExportActivity-childBulkExportActivity-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get a bulk export activity by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/bulkExportActivities/{BulkExportJobId}

Example of Response Body

The following shows an example of the response body in JSON format.

{
    "BulkExportJobId": 300100183509438,
    "Name": "Acct_Export",
    "Description": null,
    "ExportObject": "Account",
    "ExportMapping": "null",
    "ExportColumnNames": "EmailContactPointType,EmailAddress,WebContactPointType,URL,PartyNumberKey,AddressNumber,Country,PartyId,PartyNumber,OrganizationProfileId,OrganizationName,PartyUniqueName,SalesProfileNumber,OwnerPartyNumber,OwnerName,PartyType,CreatedBy,CreationDate,LastUpdateDate,LastUpdatedBy,PhoneContactPointType,FaxContactPointType",
    "ExportFilterCriteria": "OrganizationName IS NOT NULL",
    "ExportOrderBy": null,
    "ExportFileName": "Account20190927_1103.zip",
    "Status": "COMPLETE",
    "Activate": "YES",
    "DateFormat": "ORA_ZCA_US_FORMAT",
    "TimestampFormat": "ORA_ZCA_US_FORMAT",
    "Delimiter": "COMMA_DELIMITER",
    "EscapeSpecialCharactersFlag": "false",
    "RecordsExported": "",
    "ExportFileURL": "FUSION doesn't have access to this file. (ZCA-210338)",
    "ErrorReportFileURL": "FUSION doesn't have access to this file. (ZCA-210338)",
    "NotificationEMail": null,
    "FileCharset": "ORA_ZCA_UTF8_ENCODING",
    "CreatedBy": "MHoope",
    "CreationDate": "2019-09-27T11:03:08+00:00",
    "LastUpdateDate": "2019-09-27T11:09:48+00:00",
    "LastUpdatedBy": "MHoope",
    "LastUpdateLogin": "9386952CF31776BCE053A15AF00A09EE",
    "StartTm": null,
    "EndTm": null,
    "LangIndependentHeader": "NO",
    "NoteObjectCode": null,
    "EnableSplit": "NO",
    "SplitSize": 100000,
    "EnableExportAttachment": null,
    "CurrentLoggedInUser": "FUSION",
    "RestNotification": null,
    "Cancel": null,
    "CanceledBy": null,
    "PrivateMap": "N",
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438",
            "name": "bulkExportActivities",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000003770400000003737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000C7371007E0002000000017371007E00020000000378"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438",
            "name": "bulkExportActivities",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/child/Attachments",
            "name": "Attachments",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/child/childBulkExportActivity",
            "name": "childBulkExportActivity",
            "kind": "collection"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/enclosure/ExportFileContents",
            "name": "ExportFileContents",
            "kind": "other"
        },
        {
            "rel": "enclosure",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/bulkExportActivities/300100183509438/enclosure/ErrorReportFileContents",
            "name": "ErrorReportFileContents",
            "kind": "other"
        }
    ]
}
Back to Top