1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Export Job

Get an export job

get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/exportJob/{id}

Get an export job

Request

Path Parameters
Query Parameters
  • The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : ExportJobOracle
Title: ExportJobOracle
Match All
Show Source
  • ExportJob
    Title: ExportJob
    Discriminator: { "propertyName":"@type", "mapping":{ "ExportJob":"#/components/schemas/ExportJob", "ExportJobOracle":"#/components/schemas/ExportJobOracle" } }
    Represents a task used to export resources to a file
  • type
Nested Schema : ExportJob
Type: object
Title: ExportJob
Discriminator: @type

Discriminator Values

Represents a task used to export resources to a file
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : ExportOptionsOracle
Type: object
Title: ExportOptionsOracle
Represents a task used to export resources to a file
Show Source
Nested Schema : exportSummary
Type: object
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : project
Type: object
Show Source
Nested Schema : resourceType
Type: array
Type of the resource to be exported seperated by comma
Show Source
  • Allowed Values: [ "productRule", "package", "commercial_bundle", "service_bundle", "service", "device", "accessory", "productOffering", "productOfferingPrice", "priceplan", "productLine", "promotion", "constraint", "pricingLogicAlgorithmSpecification", "balanceElement", "productSpecification", "serviceSpecification", "usageSpecification", "customerProfileSpecification", "pricelist", "customProfileSpecification", "taxServiceProvider", "catalog", "category", "entitlement", "priceTag" ]
Nested Schema : resources
Type: array
Show Source
Nested Schema : ExportSummaryResource
Type: object
Title: ExportSummaryResource
This object holds exported resource details like name and count
Show Source

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

501 Response

The server doesn't support the functionality required to fulfill the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

The following example shows how to retrieve all the export jobs by submitting a get request on the REST resource using cURL.

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/exportJob/{JobId}

Example of Response Body

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

{
    "id": 129942,
    "@type": "ExportJobOracle",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/exportJob/129942",
    "status": "SUCCEEDED",
    "creationDate": "2021-03-11 11:20:34.966",
    "completionDate": "2021-03-11 11:21:32.023",
    "exportOptions": {
        "exportReferenced": true,
        "filenamePrefix": "Package001",
        "resourceType": [
            "catalog"
        ],
        "id": "OracleFusion94",
        "name": "OracleFusion94"
    },
    "createdBy": "booth",
    "path": "catalog",
    "url": "v1/exportFile/Package001_129942.json",
    "exportSummary": {
        "id": 129942,
        "totalExportObjects": 2,
        "resources": [
            {
                "name": "category",
                "count": 1
            },
            {
                "name": "catalog",
                "count": 1
            }
        ]
    }
}
Back to Top