Importing software catalog

You use the POST operation on the sam/import_catalog/complete_catalog_import element to run the software catalog import in the BFI server. You can check the import progress by using sam/import_catalog/catalog_import_status API.

Permissions

User You must have the Manage Imports permission to use the API.

Resource URL

https://hostname:port/sam/import_catalog/complete_catalog_import?token=token

Resource information

Table 1. Resource information
Operation details Description
HTTP method POST
Request headers

Header

Accept-Language (optional)

Values

en-US (only English is supported)

Negotiates the language of the response. If the header is not specified, the content is returned in the server language.

Header

Content-Type

Values

application/json

Specifies the content type of the request.
Request format application/json
Response headers

Header

Content-Type

Values

application/json

Specifies the content type of the response.

Header

Content-Language

Values

en-US, …

Specifies the language of the response content. If the header is not specified, the content is returned in the server language.
Response format application/json

Example conversation

Request
POST /sam/import_catalog/complete_catalog_import?token=150463d565467e8619b86fa77090ff06963726c9 HTTP/1.1
                            Host: localhost:9081 
                            Accept: application/json
                            Content-Type: application/json
                            Content-Length: 0
Response body
{
                            "success":true,
                            "message":"The last catalog import has completed.",
                            "status":"completed",
                            "duration_seconds":1905.33,
                            "steps_completed":30,
                            "steps_total":30,
                            "timestamp":"2026-09-08T11:34:35+00:00"
                            }