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/v4/exportJob

Create an export job

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" } }
    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
Back to Top

Response

Supported Media Types

201 Response

Your request is successful and a new resource has been created.
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

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
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
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/v4/exportJob' -D @create_exportjob.json | json_pp

Based on resource type

Request Header

The following shows an example of the response header.

{

{
"exportOptions": {
"resourceType": ["package", "commercial_bundle", "service_bundle", "service", "device", "accessory", "priceplan", "catalog", "category", "pricingLogicAlgorithmSpecification", "constraint", "productSpecification"],
"exportReferenced": false,
"filenamePrefix": "FileExport001",
"lifecycleStatus": "In design"
}
}

Response Body

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

{
    "id": 130011,
    "@type": "ExportJobOracle",
    "status": "SUCCEEDED",
    "creationDate": "2021-03-11 11:51:02.145",
    "completionDate": "",
    "exportOptions": {
        "exportReferenced": false,
        "filenamePrefix": "FileExport001",
        "lifecycleStatus": "In design",
        "resourceType": [
            "package",
            "commercial_bundle",
            "service_bundle",
            "service",
            "device",
            "accessory",
            "priceplan",
            "catalog",
            "category",
            "pricingLogicAlgorithmSpecification",
            "constraint",
            "productSpecification"
        ]
    },
    "createdBy": "booth",
    "url": "v1/exportFile/FileExport001_130011.json",
    "exportSummary": {
        "id": 130011,
        "totalExportObjects": 55,
        "resources": [
            {
                "name": "productOfferingPrice",
                "count": 13
            },
            {
                "name": "category",
                "count": 3
            },
            {
                "name": "catalog",
                "count": 2
            },
            {
                "name": "productSpecification",
                "count": 12
            },
            {
                "name": "productOffering",
                "count": 25
            }
        ]
    }
}

Based on individual resource

Request Header

The following shows an example of the request header.

{
{
    "exportOptions": {
        "resourceType": ["package"],
        "exportReferenced": false,
        "filenamePrefix": "Package001",
        "name": "BOF_27_1_2021_18_7_58"
    }
}

Response Body

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

{
        "id": 129836,
        "@type": "ExportJobOracle",
        "status": "SUCCEEDED",
        "creationDate": "2021-03-11 10:24:48.571",
        "completionDate": "2021-03-11 10:26:27.307",
        "exportOptions": {
            "exportReferenced": true,
            "filenamePrefix": "Package001",
            "resourceType": [
                "package"
            ],
            "id": "BOF_27_1_2021_18_7_58",
            "name": "BOF_27_1_2021_18_7_58"
        },
        "createdBy": "booth",
        "path": "package",
        "url": "v1/exportFile/Package001_129836.json",
        "exportSummary": {
            "id": 129836,
            "totalExportObjects": 13,
            "resources": [
                {
                    "name": "productOfferingPrice",
                    "count": 5
                },
                {
                    "name": "productLine",
                    "count": 2
                },
                {
                    "name": "balanceElement",
                    "count": 1
                },
                {
                    "name": "pricelist",
                    "count": 1
                },
                {
                    "name": "productSpecification",
                    "count": 1
                },
                {
                    "name": "productOffering",
                    "count": 3
                }
            ]
        }
    }

Based on lifecycle status

Request Header

The following shows an example of the request header.

{
    "exportOptions": {
        "resourceType": ["device"],
        "exportReferenced": false,
        "filenamePrefix": "POFile001",
         "lifecycleStatus": "In design"
    }
}

Response Body

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

{
    "id": 130129,
    "@type": "ExportJobOracle",
    "status": "SUCCEEDED",
    "creationDate": "2021-03-11 12:26:58.073",
    "completionDate": "2021-03-11 12:27:39.02",
    "exportOptions": {
        "exportReferenced": false,
        "filenamePrefix": "POFile001",
        "lifecycleStatus": "In design",
        "resourceType": [
            "device"
        ]
    },
    "createdBy": "booth",
    "path": "device",
    "url": "v1/exportFile/POFile001_130129.json",
    "exportSummary": {
        "id": 130129,
        "totalExportObjects": 18,
        "resources": [
            {
                "name": "productOffering",
                "count": 18
            }
        ]
    }
}

Based on project

Request Header

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

{
    "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
            }
        ]
    }
}
Back to Top