Jump to

• Request
• Response
• Examples

Create an import job

post

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

Create an import job

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : Item

Type: object

Title: Item

Show Source

• path: string
  path of the file to upload
• primaryFile: object primaryFile
  File to upload.

{
    "title":"Item",
    "type":"object",
    "properties":{
        "primaryFile":{
            "type":"object",
            "description":"File to upload.",
            "format":"binary"
        },
        "path":{
            "type":"string",
            "description":"path of the file to upload"
        }
    }
}

Nested Schema : primaryFile

Type: object

File to upload.

Back to Top

Response

201 Response

The import job has been created successfully.

Body ()

Root Schema : Empty Response

Type: object

Title: Empty Response

Show Source

{
    "title":"Empty Response",
    "type":"object",
    "properties":{
    }
}

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

• @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"
    ]
}

Back to Top

Examples

The following example shows how to create a import job by submitting a POST request on the REST resource using cURL.

cURL Command

curl -u username:password -X POST https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/productCatalogManagement/v4/importJob/' \ --header 'Content-Type: application/json' -D @create_importSpecifications.json | json_pp

Example of Response Body

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

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

Back to Top