REST API Reference for Launch Cloud Service

Get an export job

get

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

Get an export job

Request

Path Parameters

id(required): string

The unique identifier of the resource item.

Query Parameters

fields: string

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.

Response

Supported Media Types

application/json

200 Response

Root Schema : ExportJobOracle

Title: ExportJobOracle

Match All

Show Source

object 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
object type

{
    "title":"ExportJobOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ExportJob"
        },
        {
            "type":"object",
            "properties":{
                "createdBy":{
                    "type":"string",
                    "description":"submitter name of the job request"
                },
                "exportOptions":{
                    "$ref":"#/components/schemas/ExportOptionsOracle"
                },
                "exportSummary":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "type":"integer",
                            "format":"int64",
                            "description":"Identifier of the export job"
                        },
                        "totalExportObjects":{
                            "type":"integer",
                            "description":"Total count of the number of object exported"
                        },
                        "resources":{
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/ExportSummaryResource"
                            }
                        }
                    }
                },
                "errorLogUrl":{
                    "type":"string",
                    "description":"URL of the error Log"
                }
            },
            "required":[
                "exportOptions"
            ]
        }
    ]
}

Nested Schema : ExportJob

Type: object

Title: ExportJob

Discriminator: @type

{
    "title":"ExportJob",
    "type":"object",
    "description":"Represents a task used to export resources to a file",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Identifier of the export job"
        },
        "href":{
            "type":"string",
            "description":"Reference of the export job"
        },
        "completionDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date at which the job was completed"
        },
        "contentType":{
            "type":"string",
            "description":"The format of the exported data"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date at which the job was created"
        },
        "errorLog":{
            "type":"string",
            "description":"Reason for failure"
        },
        "path":{
            "type":"string",
            "description":"URL of the root resource acting as the source for streaming content to the file specified by the export job"
        },
        "query":{
            "type":"string",
            "description":"Used to scope the exported data"
        },
        "url":{
            "type":"string",
            "description":"URL of the file containing the data to be exported"
        },
        "status":{
            "type":"string",
            "description":"Status of the export job",
            "enum":[
                "NOT_STARTED",
                "RUNNING",
                "SUCCEEDED",
                "FAILED",
                "COMPLETED",
                "ERROR",
                "BLOCKED",
                "READY",
                "CANCELLED",
                "CANCELLING"
            ]
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ExportJob":"#/components/schemas/ExportJob",
            "ExportJobOracle":"#/components/schemas/ExportJobOracle"
        }
    }
}

Represents a task used to export resources to a file

Show Source

@baseType: string

When sub-classing, this defines the super-class
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type(required): string

When sub-classing, this defines the sub-class entity name
completionDate: string (date-time)

Date at which the job was completed
contentType: string

The format of the exported data
creationDate: string (date-time)

Date at which the job was created
errorLog: string

Reason for failure
href: string

Reference of the export job
id: integer (int64)

Identifier of the export job
path: string

URL of the root resource acting as the source for streaming content to the file specified by the export job
query: string

Used to scope the exported data
status: string

Allowed Values: [ "NOT_STARTED", "RUNNING", "SUCCEEDED", "FAILED", "COMPLETED", "ERROR", "BLOCKED", "READY", "CANCELLED", "CANCELLING" ]

Status of the export job
url: string

URL of the file containing the data to be exported

{
    "title":"ExportJob",
    "type":"object",
    "description":"Represents a task used to export resources to a file",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Identifier of the export job"
        },
        "href":{
            "type":"string",
            "description":"Reference of the export job"
        },
        "completionDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date at which the job was completed"
        },
        "contentType":{
            "type":"string",
            "description":"The format of the exported data"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date at which the job was created"
        },
        "errorLog":{
            "type":"string",
            "description":"Reason for failure"
        },
        "path":{
            "type":"string",
            "description":"URL of the root resource acting as the source for streaming content to the file specified by the export job"
        },
        "query":{
            "type":"string",
            "description":"Used to scope the exported data"
        },
        "url":{
            "type":"string",
            "description":"URL of the file containing the data to be exported"
        },
        "status":{
            "type":"string",
            "description":"Status of the export job",
            "enum":[
                "NOT_STARTED",
                "RUNNING",
                "SUCCEEDED",
                "FAILED",
                "COMPLETED",
                "ERROR",
                "BLOCKED",
                "READY",
                "CANCELLED",
                "CANCELLING"
            ]
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ExportJob":"#/components/schemas/ExportJob",
            "ExportJobOracle":"#/components/schemas/ExportJobOracle"
        }
    }
}

Nested Schema : type

Type: object

Show Source

createdBy: string

submitter name of the job request
errorLogUrl: string

URL of the error Log
exportOptions(required): object ExportOptionsOracle

Title: ExportOptionsOracle

Represents a task used to export resources to a file
exportSummary: object exportSummary

{
    "type":"object",
    "properties":{
        "createdBy":{
            "type":"string",
            "description":"submitter name of the job request"
        },
        "exportOptions":{
            "$ref":"#/components/schemas/ExportOptionsOracle"
        },
        "exportSummary":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"integer",
                    "format":"int64",
                    "description":"Identifier of the export job"
                },
                "totalExportObjects":{
                    "type":"integer",
                    "description":"Total count of the number of object exported"
                },
                "resources":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ExportSummaryResource"
                    }
                }
            }
        },
        "errorLogUrl":{
            "type":"string",
            "description":"URL of the error Log"
        }
    },
    "required":[
        "exportOptions"
    ]
}

Nested Schema : ExportOptionsOracle

Type: object

Title: ExportOptionsOracle

Represents a task used to export resources to a file

Show Source

@baseType: string

When sub-classing, this defines the super-class
@schemaLocation: string (uri)

A URI to a JSON-Schema file that defines additional attributes and relationships
@type: string

When sub-classing, this defines the sub-class entity name
exportReferenced: boolean

if referenced objects to be exported
filenamePrefix: string

Maximum Length: 30

User defined optional file name prefix
id: string

for a given resource type this is the id of the resource
lastUpdate: object TimePeriodOracle

Title: TimePeriodOracle

Validity period of the related party
lifecycleStatus: string

Status of the lifecycle to be exported
name: string

for a given resource type this is the name of the resource
project: object project
resourceType: array resourceType

Type of the resource to be exported seperated by comma

{
    "title":"ExportOptionsOracle",
    "type":"object",
    "description":"Represents a task used to export resources to a file",
    "properties":{
        "resourceType":{
            "type":"array",
            "description":"Type of the resource to be exported seperated by comma",
            "items":{
                "type":"string",
                "enum":[
                    "productRule",
                    "package",
                    "commercial_bundle",
                    "service_bundle",
                    "service",
                    "device",
                    "accessory",
                    "productOffering",
                    "productOfferingPrice",
                    "priceplan",
                    "productLine",
                    "promotion",
                    "policy",
                    "pricingLogicAlgorithmSpecification",
                    "balanceElement",
                    "productSpecification",
                    "serviceSpecification",
                    "usageSpecification",
                    "customerProfileSpecification",
                    "pricelist",
                    "customProfileSpecification",
                    "taxServiceProvider",
                    "catalog",
                    "category",
                    "entitlement",
                    "priceTag"
                ]
            }
        },
        "lifecycleStatus":{
            "type":"string",
            "description":"Status of the lifecycle to be exported"
        },
        "lastUpdate":{
            "$ref":"#/components/schemas/TimePeriodOracle"
        },
        "project":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"string",
                    "description":"Unique identifier of the project"
                },
                "name":{
                    "type":"string",
                    "description":"Name of the project"
                }
            }
        },
        "name":{
            "type":"string",
            "description":"for a given resource type this is the name of the resource"
        },
        "id":{
            "type":"string",
            "description":"for a given resource type this is the id of the resource"
        },
        "filenamePrefix":{
            "type":"string",
            "maxLength":"30",
            "description":"User defined optional file name prefix"
        },
        "exportReferenced":{
            "type":"boolean",
            "description":"if referenced objects to be exported"
        },
        "@baseType":{
            "type":"string",
            "description":"When sub-classing, this defines the super-class"
        },
        "@schemaLocation":{
            "type":"string",
            "format":"uri",
            "description":"A URI to a JSON-Schema file that defines additional attributes and relationships"
        },
        "@type":{
            "type":"string",
            "description":"When sub-classing, this defines the sub-class entity name"
        }
    }
}

Nested Schema : exportSummary

Type: object

Show Source

id: integer (int64)

Identifier of the export job
resources: array resources
totalExportObjects: integer

Total count of the number of object exported

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Identifier of the export job"
        },
        "totalExportObjects":{
            "type":"integer",
            "description":"Total count of the number of object exported"
        },
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ExportSummaryResource"
            }
        }
    }
}

Nested Schema : TimePeriodOracle

Type: object

Title: TimePeriodOracle

Validity period of the related party

Show Source

endDateTime: string (date-time)

An instant of time, ending at the TimePeriod.
startDateTime: string (date-time)

An instant of time, starting at the TimePeriod

{
    "description":"Validity period of the related party",
    "title":"TimePeriodOracle",
    "type":"object",
    "properties":{
        "startDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, starting at the TimePeriod"
        },
        "endDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"An instant of time, ending at the TimePeriod."
        }
    }
}

Nested Schema : project

Type: object

Show Source

id: string

Unique identifier of the project
name: string

Name of the project

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier of the project"
        },
        "name":{
            "type":"string",
            "description":"Name of the project"
        }
    }
}

Nested Schema : resourceType

Type: array

Type of the resource to be exported seperated by comma

Show Source

Array of: string

Allowed Values: [ "productRule", "package", "commercial_bundle", "service_bundle", "service", "device", "accessory", "productOffering", "productOfferingPrice", "priceplan", "productLine", "promotion", "policy", "pricingLogicAlgorithmSpecification", "balanceElement", "productSpecification", "serviceSpecification", "usageSpecification", "customerProfileSpecification", "pricelist", "customProfileSpecification", "taxServiceProvider", "catalog", "category", "entitlement", "priceTag" ]

{
    "type":"array",
    "description":"Type of the resource to be exported seperated by comma",
    "items":{
        "type":"string",
        "enum":[
            "productRule",
            "package",
            "commercial_bundle",
            "service_bundle",
            "service",
            "device",
            "accessory",
            "productOffering",
            "productOfferingPrice",
            "priceplan",
            "productLine",
            "promotion",
            "policy",
            "pricingLogicAlgorithmSpecification",
            "balanceElement",
            "productSpecification",
            "serviceSpecification",
            "usageSpecification",
            "customerProfileSpecification",
            "pricelist",
            "customProfileSpecification",
            "taxServiceProvider",
            "catalog",
            "category",
            "entitlement",
            "priceTag"
        ]
    }
}

Nested Schema : resources

Type: array

Show Source

Array of: object ExportSummaryResource

Title: ExportSummaryResource

This object holds exported resource details like name and count

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ExportSummaryResource"
    }
}

Nested Schema : ExportSummaryResource

Type: object

Title: ExportSummaryResource

This object holds exported resource details like name and count

Show Source

count: integer

Indicates the number of resource exported
name: string

Name of the resource exported

{
    "type":"object",
    "title":"ExportSummaryResource",
    "description":"This object holds exported resource details like name and count",
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of the resource exported"
        },
        "count":{
            "type":"integer",
            "description":"Indicates the number of resource exported"
        }
    }
}

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.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

404 Response

Your request includes a resource URI that doesn't exist.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

500 Response

The server encountered something unexpected that prevented it from completing the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

501 Response

The server doesn't support the functionality required to fulfill the request.

Root Schema : Error

Type: object

Title: Error

Show Source

@schemaLocation: string

it provides a link to the schema describing a REST resource.
@type: string

The class type of a REST resource.
code(required): string

Application related code (as defined in the API or from a common list)
message: string

Text that provide more details and corrective actions related to the error. This can be shown to a client user.
reason(required): string

Text that explains the reason for error. This can be shown to a client user.
referenceError: string

url pointing to documentation describing the error
status: string

http error code extension like 400-2

{
    "title":"Error",
    "type":"object",
    "properties":{
        "code":{
            "type":"string",
            "description":"Application related code (as defined in the API or from a common list)"
        },
        "reason":{
            "type":"string",
            "description":"Text that explains the reason for error. This can be shown to a client user."
        },
        "message":{
            "type":"string",
            "description":"Text that provide more details and corrective actions related to the error. This can be shown to a client user."
        },
        "status":{
            "type":"string",
            "description":"http error code extension like 400-2"
        },
        "referenceError":{
            "type":"string",
            "description":"url pointing to documentation describing the error"
        },
        "@type":{
            "type":"string",
            "description":"The class type of a REST resource."
        },
        "@schemaLocation":{
            "type":"string",
            "description":"it provides a link to the schema describing a REST resource."
        }
    },
    "required":[
        "code",
        "reason"
    ]
}

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/v5/exportJob/{JobId}

Example of Response Body

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

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