API Description

This section lists the operations that can be performed by REST API on the DSPackageInstaller.war webapp.

Package Operations

Design Studio packages are part of the DSPackageInstaller.war webapp and their content can be browsed by using the following operations.

Request type Resource URI Action

Description

GET

/DSPackageInstaller/resources/package

Get /WEB-INF/packages/package-list content

Returns the package names referenced within the package-list file. These file entries must represent a valid package directory under /WEB-INF/packages/{packageName}.

GET

/DSPackageInstaller/resources/package/{packageName}

Get /WEB-INF/packages/{packageName}/package-detail content

Returns the package records referenced within the package-detail file. A package record entry format is {uniqueKey}#{recordPath} where the record path must be a valid file path under /WEB-INF/packages/{recordPath}

GET

/DSPackageInstaller/resources/package/{recordPath}

Get /WEB-INF/packages/{recordPath} content

Returns the record or file content for the specified recordPath which must exist under /WEB-INF/packages/{recordPath}

Staging Area Operations

The DSPackageInstaller staging area is a Temenos Transact RDBMS set of tables allowing packages storage for their installation. The staging area can be created, cleared and dropped by using the following operations.

Request type Resource URI Action Description

GET

/DSPackageInstaller/resources/

staging

Get staging area status

Check whether the tables making the staging area are existing or missing. If they are missing, then they must be created prior to any staging operation.

POST

/DSPackageInstaller/resources/

staging

Create staging area

Triggers the staging area tables creation, returns a successful status if all tables have been created successfully.

POST

/DSPackageInstaller/resources/

staging/clear

Clear staging area

Delete all records from the staging area tables, returns a successful status if all tables have been cleared successfully.

DELETE

/DSPackageInstaller/resources/

staging

Drop staging area

Drop all staging area tables, returns a successful status if all tables have been dropped successfully.

Packages Staging Operations

Since the staging area is correctly initialized and valid packages are present within DSPackageInstaller.war, it is possible to perform the following write, read and delete operations.

Request type Resource URI Form URL encoded parameters Action Description

PUT

/DSPackageInstaller/resources/staging/all

 

Put all packages into staging area

For each package part of package-list, write all records, part of the package-detail file to staging area tables. A successful status is returned when all records have been written successfully.

PUT

/DSPackageInstaller/resources/staging

packageName

Put a package into staging area

Writes all records, part of the package-detail file identified by the path parameter packageName, to staging area tables. A successful status is returned when all records have been written successfully.

PUT

/DSPackageInstaller/resources/staging/record

recordKey recordPath

Put a record into staging area

Writes a single record, identified by the form URL parameters recordKey and recordPath, to staging area tables. The recordKey must be a unique key as defined in the package.detail file, and the recordPath must be the valid path to the record file under WEB-INF/packages/{recordPath}. A successful status is returned when the records has been written successfully.

GET

/DSPackageInstaller/resources/staging/{packageName}

 

Get a package from staging area

Checks if all records are part of the package-detail file.

Identified by the path parameter packageName, are part of the staging area tables. Returns the list of files successfully found in staging area and the list of missing files. Operation status is success when all files are present in staging area.

GET

/DSPackageInstaller/resources/staging/record/{recordKey}

 

Get a record from staging area

Checks whether a specific record identified by the path parameter recordKey is present in the staging area tables. Returns success if the record is present.

DELETE

/DSPackageInstaller/resources/staging/all

 

Delete all package(s) from staging area

For each package part of package-list, deletes all records part of the package-detail file from the staging area tables. Returns the list of files successfully deleted in staging area and the list of files for which it failed. Operation status is success when all files have been deleted.

DELETE

/DSPackageInstaller/resources/staging/{packageName}

 

Delete a package from staging area

Deletes all records part of the package-detail file, identified by the path parameter packageName, from the staging area tables. Returns the list of files successfully deleted in staging area and the list of files for which it failed. Operation status is success when all files have been deleted.

DELETE

/DSPackageInstaller/resources/staging/record/{recordKey}

 

Delete a record from staging area

Deletes a specific record identified by the path parameter recordKey from the staging area tables. Returns success if the record has been successfully deleted.

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?