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

Create an export job

post

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

Creates an export job using the supplied request payload and starts the export process.

Request

There are no request parameters for this operation.

Supported Media Types
Request Body - application/json ()
Root Schema : ExportJobOracle
Title: ExportJobOracle
Match All
Show Source
  • ExportJob
    Title: ExportJob
    Discriminator: { "propertyName":"@type", "mapping":{ "ExportJob":"#/components/schemas/ExportJob", "ExportJobOracle":"#/components/schemas/ExportJobOracle" } }
    The task that exports resources to a file.
  • type
Nested Schema : ExportJob
Type: object
Title: ExportJob
Discriminator: @type

Discriminator Values

The task that exports resources to a file.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : ExportOptionsOracle
Type: object
Title: ExportOptionsOracle
The task that exports resources to a file.
Show Source
Nested Schema : exportSummary
Type: object
The summary of the export job.
Show Source
Nested Schema : filter
Type: array
A list of filters associated with the export option.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
The validity period of the related party.
Show Source
Nested Schema : notificationUsers
Type: array
A list of notification users associated with the export option.
Show Source
Nested Schema : project
Type: object
The project associated with the export options.
Show Source
Nested Schema : resourceType
Type: array
A list of resource types associated with the export option.
Show Source
  • Allowed Values: [ "productRule", "package", "commercial_bundle", "service_bundle", "service", "device", "accessory", "productOffering", "productOfferingPrice", "priceplan", "productLine", "promotion", "policyRule", "pricingLogicAlgorithmSpecification", "balanceElement", "productSpecification", "serviceSpecification", "usageSpecification", "customerProfileSpecification", "pricelist", "customProfileSpecification", "taxServiceProvider", "catalog", "category", "entitlement", "priceTag" ]
Nested Schema : ScheduleJobOracle
Type: object
The schedule job resource.
Show Source
Nested Schema : ExportFilterOracle
Type: object
Title: ExportFilterOracle
The export filter resource.
Show Source
Nested Schema : recurrenceFields
Type: object
The recurrence fields associated with the schedule job.
Show Source
Nested Schema : dayOfMonth
Type: array
A list of day of months associated with the schedule job.
Show Source
Nested Schema : dayOfWeek
Type: array
A list of day of weeks associated with the schedule job.
Show Source
  • Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
    Indicates the day of week for schedule job recurrence. Valid values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.
Nested Schema : monthOfyear
Type: array
A list of month ofyears associated with the schedule job.
Show Source
  • Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
    Indicates the month of year for schedule job recurrence. Valid values are JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, and DECEMBER.
Nested Schema : timeOfDay
Type: object
Indicates the time of day for schedule job recurrence.
Show Source
  • Minimum Value: 0
    Maximum Value: 23
    The hour associated with the schedule job.
  • Minimum Value: 0
    Maximum Value: 59
    The minute associated with the schedule job.
  • Minimum Value: 0
    Maximum Value: 59
    The second associated with the schedule job.
Nested Schema : weekOfMonth
Type: array
A list of week of months associated with the schedule job.
Show Source
  • Allowed Values: [ "FIRST", "SECOND", "THIRD", "FOURTH", "FIFTH", "LAST" ]
    Indicates the week of month for schedule job recurrence. Valid values are FIRST, SECOND, THIRD, FOURTH, FIFTH, and LAST.
Nested Schema : resources
Type: array
A list of resources included in the export summary.
Show Source
Nested Schema : ExportSummaryResource
Type: object
Title: ExportSummaryResource
The object that contains exported resource details, such as name and count.
Show Source
Back to Top

Response

Supported Media Types

201 Response

The export job was created successfully.
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" } }
    The task that exports resources to a file.
  • type
Nested Schema : ExportJob
Type: object
Title: ExportJob
Discriminator: @type

Discriminator Values

The task that exports resources to a file.
Show Source
Nested Schema : type
Type: object
Show Source
Nested Schema : ExportOptionsOracle
Type: object
Title: ExportOptionsOracle
The task that exports resources to a file.
Show Source
Nested Schema : exportSummary
Type: object
The summary of the export job.
Show Source
Nested Schema : filter
Type: array
A list of filters associated with the export option.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
The validity period of the related party.
Show Source
Nested Schema : notificationUsers
Type: array
A list of notification users associated with the export option.
Show Source
Nested Schema : project
Type: object
The project associated with the export options.
Show Source
Nested Schema : resourceType
Type: array
A list of resource types associated with the export option.
Show Source
  • Allowed Values: [ "productRule", "package", "commercial_bundle", "service_bundle", "service", "device", "accessory", "productOffering", "productOfferingPrice", "priceplan", "productLine", "promotion", "policyRule", "pricingLogicAlgorithmSpecification", "balanceElement", "productSpecification", "serviceSpecification", "usageSpecification", "customerProfileSpecification", "pricelist", "customProfileSpecification", "taxServiceProvider", "catalog", "category", "entitlement", "priceTag" ]
Nested Schema : ScheduleJobOracle
Type: object
The schedule job resource.
Show Source
Nested Schema : ExportFilterOracle
Type: object
Title: ExportFilterOracle
The export filter resource.
Show Source
Nested Schema : recurrenceFields
Type: object
The recurrence fields associated with the schedule job.
Show Source
Nested Schema : dayOfMonth
Type: array
A list of day of months associated with the schedule job.
Show Source
Nested Schema : dayOfWeek
Type: array
A list of day of weeks associated with the schedule job.
Show Source
  • Allowed Values: [ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ]
    Indicates the day of week for schedule job recurrence. Valid values are MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY.
Nested Schema : monthOfyear
Type: array
A list of month ofyears associated with the schedule job.
Show Source
  • Allowed Values: [ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ]
    Indicates the month of year for schedule job recurrence. Valid values are JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, and DECEMBER.
Nested Schema : timeOfDay
Type: object
Indicates the time of day for schedule job recurrence.
Show Source
  • Minimum Value: 0
    Maximum Value: 23
    The hour associated with the schedule job.
  • Minimum Value: 0
    Maximum Value: 59
    The minute associated with the schedule job.
  • Minimum Value: 0
    Maximum Value: 59
    The second associated with the schedule job.
Nested Schema : weekOfMonth
Type: array
A list of week of months associated with the schedule job.
Show Source
  • Allowed Values: [ "FIRST", "SECOND", "THIRD", "FOURTH", "FIFTH", "LAST" ]
    Indicates the week of month for schedule job recurrence. Valid values are FIRST, SECOND, THIRD, FOURTH, FIFTH, and LAST.
Nested Schema : resources
Type: array
A list of resources included in the export summary.
Show Source
Nested Schema : ExportSummaryResource
Type: object
Title: ExportSummaryResource
The object that contains exported resource details, such as 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
The error resource.
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
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
Show Source

500 Response

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

Examples

The following examples show how to retrieve an export job by submitting a get request on the REST resource using cURL.

curl -u username:password -X POST \ 
'https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/exportJob' -D @create_exportjob.json | json_pp

Based on Resource Type

Request Body

The following shows an example of the request body.

{
    "@type" : "ExportJobOracle",
    "exportOptions": {
        "resourceType": [
            "package",
            "commercial_bundle",
            "service_bundle",
            "service",
            "device",
            "accessory",
            "priceplan",
            "catalog",
            "category",
            "pricingLogicAlgorithmSpecification",
            "policy",
            "productSpecification"
        ],
        "exportReferenced": false,
        "filenamePrefix": "FileExport001"        
    }
}

Response Body

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

{
    "id": 151897,
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/exportJob/151897",
    "status": "NOT_STARTED",
    "creationDate": "2025-02-19 16:24:34.729",
    "@type": "ExportJobOracle",
    "exportOptions": {
        "filenamePrefix": "FileExport001",        
        "exportReferenced": false,
        "resourceType": [
            "package",
            "commercial_bundle",
            "service_bundle",
            "service",
            "device",
            "accessory",
            "priceplan",
            "catalog",
            "category",
            "pricingLogicAlgorithmSpecification",
            "policy",
            "productSpecification"
        ]
    },
    "contentType": "application/json"
}

Based on Individual Resource

Request Body

The following shows an example of the request body.

{
    "@type" : "ExportJobOracle",
    "exportOptions": {
        "resourceType": [
            "package"
        ],
        "exportReferenced": false,
        "filenamePrefix": "Package001",
        "name": "MCC2LP"
    }
}

Response Body

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

{
    "id": 151916,
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/exportJob/151916",
    "status": "NOT_STARTED",
    "creationDate": "2025-02-19 16:29:28.326",
    "@type": "ExportJobOracle",
    "exportOptions": {
        "id": "ID-3374417394-1739958333270",
        "name": "MCC2LP",
        "filenamePrefix": "Package001",
        "exportReferenced": false,
        "resourceType": [
            "package"
        ]
    },
    "contentType": "application/json",
    "path": "package"
}

Based on Project

Request Body

Prerequisite: Complete the design of the project before exporting. The following shows an example of the request body. 

{
    "exportOptions": {
        "project": {
            "name": "MarchRegProj2027",
             "id": "MarchRegProj2027"
        },
        "filenamePrefix": "MyProjPromO123"
    }
}

Response Body

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

{
    "id": 130088,
    "@type": "ExportJobOracle",
    "status": "SUCCEEDED",
    "creationDate": "2021-03-11 12:05:38.863",
    "completionDate": "2021-03-11 12:06:37.784",
    "exportOptions": {
        "exportReferenced": false,
        "project": {
            "id": "MarchRegProj2027",
            "name": "MarchRegProj2027"
        },
        "filenamePrefix": "MyProjPromO123"
    },
    "createdBy": "booth",
    "url": "v1/exportFile/MyProjPromO123_130088.json",
    "exportSummary": {
        "id": 130088,
        "totalExportObjects": 2,
        "resources": [
            {
                "name": "category",
                "count": 1
            },
            {
                "name": "catalog",
                "count": 1
            }
        ]
    }
}

Export in Hourly Schedule

Request Body

The following shows an example of the request body.

{
    "exportOptions": {
        "resourceType": [
            "productOffering"
        ],
        "filenamePrefix": "ProductOffering04212026121717",
        "exportReferenced": false,
        "fileFormat": "csv",
        "scheduleJob": {
            "name": "ProductOffering04212026121606",
            "startDateTime": "2026-04-21T06:48:17+00:00",
            "endDateTime": "2026-04-22T06:45:58+00:00",
            "recurrenceFields": {
                "frequency": "HOURLY",
                "hourInterval": 5,
                "minuteInterval": 0
            }
        },
        "notificationUsers": [
            "celine.sutherland"
        ],
        "filter": [
            {
                "field": "project.id",
                "value": "ProjectK3C7BK3MN2XGP95"
            }
        ]
    },
    "@type": "ExportJobOracle"
}

Response Body

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

{
    "id": 736942,
    "status": "NOT_STARTED",
    "creationDate": "2026-04-24 07:05:33.019",
    "@type": "ExportJobOracle",
    "exportOptions": {
        "notificationUsers": [
            "celine.sutherland"
        ],
        "filenamePrefix": "ProductOffering04212026121717",
        "filter": [
            {
                "field": "project.id",
                "value": "ProjectK3C7BK3MN2XGP95"
            }
        ],
        "scheduleJob": {
            "name": "ProductOffering04212026121606",
            "startDateTime": "2026-04-24T06:48:17+00:00",
            "endDateTime": "2026-04-30T06:45:58+00:00",
            "recurrenceFields": {
                "frequency": "HOURLY",
                "hourInterval": 5,
                "minuteInterval": 0
            }
        },
        "exportReferenced": false,
        "resourceType": [
            "productOffering"
        ],
        "fileFormat": "csv"
    },
    "contentType": "application/json",
    "path": "productOffering"
}

Export in Daily Schedule

Request Body

The following shows an example of the request body.

{
    "exportOptions": {
        "resourceType": [
            "productOffering"
        ],
        "filenamePrefix": "ProductOffering04212026120040",
        "exportReferenced": false,
        "fileFormat": "json",
        "scheduleJob": {
            "name": "ProductOffering04212026115853",
            "startDateTime": "2026-04-21T07:00:36+00:00",
            "endDateTime": "2026-04-25T07:00:36+00:00",
            "recurrenceFields": {
                "frequency": "DAILY",
                "interval": 1
            }
        },
        "notificationUsers": [
            "Monica.Suchet"
        ],
        "filter": [
            {
                "field": "validFor.startDateTime.gte",
                "value": "2026-02-01T00:00:00.000Z"
            },
            {
                "field": "validFor.endDateTime.lte",
                "value": "2026-04-21T00:00:00.000Z"
            },
            {
                "field": "lifecycleStatus",
                "value": "IN_DESIGN,IN_TEST"
            }
        ]
    },
    "@type": "ExportJobOracle"
}

Response Body

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

{
    "id": 736963,
    "status": "NOT_STARTED",
    "creationDate": "2026-04-24 07:18:54.456",
    "@type": "ExportJobOracle",
    "exportOptions": {
        "notificationUsers": [
            "Monica.Suchet"
        ],
        "filenamePrefix": "ProductOffering04212026120040",
        "filter": [
            {
                "field": "validFor.startDateTime.gte",
                "value": "2026-02-01T00:00:00.000Z"
            },
            {
                "field": "validFor.endDateTime.lte",
                "value": "2026-04-21T00:00:00.000Z"
            },
            {
                "field": "lifecycleStatus",
                "value": "IN_DESIGN,IN_TEST"
            }
        ],
        "scheduleJob": {
            "name": "ProductOffering04212026115853",
            "startDateTime": "2026-04-21T07:00:36+00:00",
            "endDateTime": "2026-04-25T07:00:36+00:00",
            "recurrenceFields": {
                "frequency": "DAILY",
                "interval": 1
            }
        },
        "exportReferenced": false,
        "resourceType": [
            "productOffering"
        ],
        "fileFormat": "json"
    },
    "contentType": "application/json",
    "path": "productOffering"
}

Export in Weekly Schedule

Request Body

The following shows an example of the request body.

{
    "exportOptions": {
        "resourceType": [
            "productOffering"
        ],
        "filenamePrefix": "ProductOffering04212026120444",
        "exportReferenced": false,
        "fileFormat": "json",
        "scheduleJob": {
            "name": "ProductOffering04212026120216",
            "startDateTime": "2026-04-21T06:35:44+00:00",
            "endDateTime": "2026-05-21T02:30:00+00:00",
            "recurrenceFields": {
                "frequency": "WEEKLY",
                "interval": 1,
                "dayOfWeek": [
                    "THURSDAY"
                ]
            }
        },
        "notificationUsers": [
            "Monica.Suchet"
        ],
        "filter": [
            {
                "field": "project.id",
                "value": "ProjectK3C7BK3MN2XGP95"
            }
        ]
    },
    "@type": "ExportJobOracle"
}

Response Body

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

{
    "id": 736967,
    "status": "NOT_STARTED",
    "creationDate": "2026-04-24 07:21:12.818",
    "@type": "ExportJobOracle",
    "exportOptions": {
        "notificationUsers": [
            "Monica.Suchet"
        ],
        "filenamePrefix": "ProductOffering04212026120444",
        "filter": [
            {
                "field": "project.id",
                "value": "ProjectK3C7BK3MN2XGP95"
            }
        ],
        "scheduleJob": {
            "name": "ProductOffering04212026120216",
            "startDateTime": "2026-04-21T06:35:44+00:00",
            "endDateTime": "2026-05-21T02:30:00+00:00",
            "recurrenceFields": {
                "frequency": "WEEKLY",
                "interval": 1,
                "dayOfWeek": [
                    "THURSDAY"
                ]
            }
        },
        "exportReferenced": false,
        "resourceType": [
            "productOffering"
        ],
        "fileFormat": "json"
    },
    "contentType": "application/json",
    "path": "productOffering"
}

Export in Monthly Schedule

Request Body

The following shows an example of the request body.

{
    "exportOptions": {
        "resourceType": [
            "productLine"
        ],
        "filenamePrefix": "ProductLine04212026120812",
        "exportReferenced": false,
        "fileFormat": "json",
        "scheduleJob": {
            "name": "ProductLine04212026120615",
            "startDateTime": "2026-04-21T06:39:12+00:00",
            "endDateTime": "2026-07-31T00:00:00+00:00",
            "recurrenceFields": {
                "frequency": "MONTHLY",
                "interval": 0,
                "weekOfMonth": [
                    "LAST"
                ],
                "dayOfWeek": [
                    "TUESDAY"
                ]
            }
        },
        "notificationUsers": [
            "Monica.Suchet",
            "rachel.gosling"
        ],
        "filter": [
            {
                "field": "lifecycleStatus",
                "value": "IN_DESIGN"
            }
        ]
    },
    "@type": "ExportJobOracle"
}

Response Body

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

{
    "id": 736972,
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v5/exportJob/736972",
    "status": "NOT_STARTED",
    "creationDate": "2026-04-24 07:24:45.777",
    "@type": "ExportJobOracle",
    "exportOptions": {
        "notificationUsers": [
            "Monica.Suchet",
            "rachel.gosling"
        ],
        "filenamePrefix": "ProductLine04212026120812",
        "filter": [
            {
                "field": "lifecycleStatus",
                "value": "IN_DESIGN"
            }
        ],
        "scheduleJob": {
            "name": "ProductLine04212026120615",
            "startDateTime": "2026-04-21T06:39:12+00:00",
            "endDateTime": "2026-07-31T00:00:00+00:00",
            "recurrenceFields": {
                "frequency": "MONTHLY",
                "interval": 0,
                "weekOfMonth": [
                    "LAST"
                ],
                "dayOfWeek": [
                    "TUESDAY"
                ]
            }
        },
        "exportReferenced": false,
        "resourceType": [
            "productLine"
        ],
        "fileFormat": "json"
    },
    "contentType": "application/json",
    "path": "productLine"
}
Back to Top