Jump to

• Request
• Response

Import Sample Packages

post

/ic/api/integration/v1/packages/loadSamples

Imports sample packages. If you already have sample integrations, getting new samples will overwrite existing integrations with the same name and version. If a sample integration is active or locked, it will not be overwritten.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : samples

Type: object

Show Source

• links: array links
• packages: array packages

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/SuiteLink"
            }
        },
        "packages":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PackageSamplesRs"
            }
        }
    },
    "xml":{
        "name":"samples"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object SuiteLink

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/SuiteLink"
    }
}

Nested Schema : packages

Type: array

Show Source

• Array of: object PackageSamplesRs

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PackageSamplesRs"
    }
}

Nested Schema : SuiteLink

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

Nested Schema : PackageSamplesRs

Type: object

Show Source

• integrations: array integrations
• packageName: string
• status: string

{
    "type":"object",
    "properties":{
        "packageName":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "integrations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IntegrationSampleRs"
            }
        }
    }
}

Nested Schema : integrations

Type: array

Show Source

• Array of: object IntegrationSampleRs

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/IntegrationSampleRs"
    }
}

Nested Schema : IntegrationSampleRs

Type: object

Show Source

• code: string
• integrationName: string
• version: string

{
    "type":"object",
    "properties":{
        "integrationName":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        }
    }
}

500 Response

Server error

Back to Top