| Info |
|---|
This API is available starting with version @5.2.0.1 |
...
| Attribute | Type | Description |
|---|---|---|
| filePath | String | Fully qualified path of the file |
| objectType | String | Type of the object |
| sequenceNumber | Integer | Order placement of this file in the package |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Project Package was found and returned |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project or Package not found |
| 500 | Unexpected internal server error |
Example
If we had a package with the name ALM-150 in a project with id 14935, when we run a GET request at the URL
...
| Attribute | Type | Description |
|---|---|---|
| filePath | String | Fully qualified path of the file |
| objectType | String | Type of the object |
| sequenceNumber | Integer | Order placement of this file in the package |
Example
...
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Project Package was created successfully |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project or Package not found |
| 500 | Unexpected internal server error |
Example
If the POST request receives the following JSON package object,
...
| Attribute | Type | Description |
|---|---|---|
| filePath | String | Fully qualified path of the file |
| objectType | String | Type of the object |
| sequenceNumber | Integer | Order placement of this file in the packageof this file in the package |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Project Package was found and updated |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project or Package not found |
| 500 | Unexpected internal server error |
Example
If we had an package in a project with id 14935 with the following attributes:
...
...
PATCH
This PATCH service will update an existing package with the information passed through a JSON object. If an attribute of the JSON is null, it will not be updated in the package. Any new files included in the request will be appended to the list of files already in the package.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/project/{projectId}/package/{packageName} |
...
| Attribute | Type | Description |
|---|---|---|
| filePath | String | Fully qualified path of the file |
| objectType | String | Type of the object |
| sequenceNumber | Integer | Order placement of this file in the package |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Project Package was found and updated |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project or Package not found |
| 500 | Unexpected internal server error |
Example
If we had an package in a project with id 14935 with the following attributes:
...
Parameter | Type | Required | Description |
|---|---|---|---|
projectId | URL | Yes | This is a URL parameter for the Project Id which is searched to find package. |
| packageName | URL | Yes | This is a URL parameter for the Package which will be deleted from project. |
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Package was deleted or not present. |
| 400 | Bad request |
| 401 | Authentication failure |
| 403 | Authorization failure (no access to resource) |
| 404 | Project not found |
| 500 | Unexpected internal server error |
...