Skip to main content

Download import job result

GET 

/sp-config/import/:id/download

This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import. The request will need the following security scope:

  • sp:config:manage

Request

Path Parameters

    id stringrequired

    The ID of the import job whose results will be downloaded.

    Example: ef38f94347e94562b5bb8424a56397d8

Responses

Import results JSON object, containing detailed results of the import operation.

Schema

    results

    object

    required

    The results of an object configuration import job.

    property name*

    Import Object Response Body

    Response model for import of a single object.

    infos

    object[]

    required

    Informational messages returned from the target service on import.

  • Array [

  • key stringrequired

    Message key.

    text stringrequired

    Message text.

    details

    object

    required

    Message details if any, in key:value pairs.

  • ]

  • warnings

    object[]

    required

    Warning messages returned from the target service on import.

  • Array [

  • key stringrequired

    Message key.

    text stringrequired

    Message text.

    details

    object

    required

    Message details if any, in key:value pairs.

  • ]

  • errors

    object[]

    required

    Error messages returned from the target service on import.

  • Array [

  • key stringrequired

    Message key.

    text stringrequired

    Message text.

    details

    object

    required

    Message details if any, in key:value pairs.

  • ]

  • importedObjects

    object[]

    required

    References to objects that were created or updated by the import.

  • Array [

  • type string

    Possible values: [IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, TRIGGER_SUBSCRIPTION]

    DTO type of object created or updated by import.

    id string

    ID of object created or updated by import.

    name string

    Display name of object created or updated by import.

  • ]

  • exportJobId string

    If a backup was performed before the import, this will contain the jobId of the backup job. This id can be used to retrieve the json file of the backup export.

Loading...