REST API Reference for Launch Cloud Service

Get an import job

get

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

ImportJob Get By Id

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 : ImportJobOracle

Title: ImportJobOracle

Match All

Show Source

object ImportJob

Title: ImportJob

Discriminator: { "propertyName":"@type", "mapping":{ "ImportJob":"#/components/schemas/ImportJob", "ImportJobOracle":"#/components/schemas/ImportJobOracle" } }
object ImportJobOracle-allOf[1]

{
    "title":"ImportJobOracle",
    "allOf":[
        {
            "$ref":"#/components/schemas/ImportJob"
        },
        {
            "type":"object",
            "properties":{
                "fileName":{
                    "type":"string",
                    "description":"file name of the submitted job request"
                },
                "createdBy":{
                    "type":"string",
                    "description":"submitter name of the job request"
                },
                "errorLogUrl":{
                    "type":"string",
                    "description":"URL of the error Log"
                },
                "importSummary":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "type":"integer",
                            "format":"int64",
                            "description":"Identifier of the import job"
                        },
                        "totalImportObjects":{
                            "type":"integer",
                            "description":"Total count of the number of object imported"
                        },
                        "resources":{
                            "type":"array",
                            "items":{
                                "$ref":"#/components/schemas/ImportSummaryResource"
                            }
                        }
                    }
                }
            }
        }
    ]
}

Nested Schema : ImportJob

Type: object

Title: ImportJob

Discriminator: @type

{
    "title":"ImportJob",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Unique identifier of the submitted job request"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the job request"
        },
        "completionDate":{
            "type":"string",
            "format":"date-time",
            "description":"Completed date-time of the job request"
        },
        "contentType":{
            "type":"string",
            "description":"Content type of the job request"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time",
            "description":"Submission Date of the job request"
        },
        "errorLog":{
            "type":"string",
            "description":"Error Log for the job request"
        },
        "path":{
            "type":"string",
            "description":"Path of the job request file"
        },
        "url":{
            "type":"string",
            "description":"Url of the job request"
        },
        "status":{
            "type":"string",
            "description":"Status of the submitted job request",
            "enum":[
                "NOT_STARTED",
                "RUNNING",
                "SUCCEEDED",
                "FAILED",
                "COMPLETED",
                "ERROR",
                "BLOCKED",
                "READY",
                "CANCELLED",
                "CANCELLING"
            ]
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of Job Request."
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ImportJob":"#/components/schemas/ImportJob",
            "ImportJobOracle":"#/components/schemas/ImportJobOracle"
        }
    }
}

Show Source

@baseType: string

Indicates the base (class) type of this REST resource
@schemaLocation: string

This field provides a link to the schema describing this REST resource
@type(required): string

Indicates the (class) type of Job Request.
completionDate: string (date-time)

Completed date-time of the job request
contentType: string

Content type of the job request
creationDate: string (date-time)

Submission Date of the job request
errorLog: string

Error Log for the job request
href: string

Unique reference of the job request
id: integer (int64)

Unique identifier of the submitted job request
path: string

Path of the job request file
status: string

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

Status of the submitted job request
url: string

Url of the job request

{
    "title":"ImportJob",
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Unique identifier of the submitted job request"
        },
        "href":{
            "type":"string",
            "description":"Unique reference of the job request"
        },
        "completionDate":{
            "type":"string",
            "format":"date-time",
            "description":"Completed date-time of the job request"
        },
        "contentType":{
            "type":"string",
            "description":"Content type of the job request"
        },
        "creationDate":{
            "type":"string",
            "format":"date-time",
            "description":"Submission Date of the job request"
        },
        "errorLog":{
            "type":"string",
            "description":"Error Log for the job request"
        },
        "path":{
            "type":"string",
            "description":"Path of the job request file"
        },
        "url":{
            "type":"string",
            "description":"Url of the job request"
        },
        "status":{
            "type":"string",
            "description":"Status of the submitted job request",
            "enum":[
                "NOT_STARTED",
                "RUNNING",
                "SUCCEEDED",
                "FAILED",
                "COMPLETED",
                "ERROR",
                "BLOCKED",
                "READY",
                "CANCELLED",
                "CANCELLING"
            ]
        },
        "@baseType":{
            "type":"string",
            "description":"Indicates<b> </b>the base (class) type of this REST resource"
        },
        "@schemaLocation":{
            "type":"string",
            "description":"This field provides a link to the schema describing this REST resource"
        },
        "@type":{
            "type":"string",
            "description":"Indicates the (class) type of Job Request."
        }
    },
    "required":[
        "@type"
    ],
    "discriminator":{
        "propertyName":"@type",
        "mapping":{
            "ImportJob":"#/components/schemas/ImportJob",
            "ImportJobOracle":"#/components/schemas/ImportJobOracle"
        }
    }
}

Nested Schema : ImportJobOracle-allOf[1]

Type: object

Show Source

createdBy: string

submitter name of the job request
errorLogUrl: string

URL of the error Log
fileName: string

file name of the submitted job request
importSummary: object importSummary

{
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string",
            "description":"file name of the submitted job request"
        },
        "createdBy":{
            "type":"string",
            "description":"submitter name of the job request"
        },
        "errorLogUrl":{
            "type":"string",
            "description":"URL of the error Log"
        },
        "importSummary":{
            "type":"object",
            "properties":{
                "id":{
                    "type":"integer",
                    "format":"int64",
                    "description":"Identifier of the import job"
                },
                "totalImportObjects":{
                    "type":"integer",
                    "description":"Total count of the number of object imported"
                },
                "resources":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/ImportSummaryResource"
                    }
                }
            }
        }
    }
}

Nested Schema : importSummary

Type: object

Show Source

id: integer (int64)

Identifier of the import job
resources: array resources
totalImportObjects: integer

Total count of the number of object imported

{
    "type":"object",
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"Identifier of the import job"
        },
        "totalImportObjects":{
            "type":"integer",
            "description":"Total count of the number of object imported"
        },
        "resources":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ImportSummaryResource"
            }
        }
    }
}

Nested Schema : resources

Type: array

Show Source

Array of: object ImportSummaryResource

Title: ImportSummaryResource

This object holds imported resource details like name and count

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

Nested Schema : ImportSummaryResource

Type: object

Title: ImportSummaryResource

This object holds imported resource details like name and count

Show Source

count: integer

Indicates the number of resource imported
name: string

Name of the resource imported

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

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 get the status of an import job 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/importJob/47353

Example of Response Body

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

{
    "id": 47353,
    "contentType": "application/json",
    "status": "Complete",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/importJob/47353",
    "path": "tmf-api/productCatalogManagement/v4/importJob/Specifications_72.json",
    "creationDate": "2020-08-20 18:28:09.974",
    "@type": "ImportJob"
}