| Info |
|---|
This API is available starting with version @5.2.0.1 |
...
| Attribute | Type | Description |
|---|
| name | String | Name of the package |
| description | String | Description of the package |
| files | List<PackageFile> | All files in the package. More info on the PackageFile object is included below. |
PackageFile
| 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 |
...
| Attribute | Type | Description |
|---|
| name | String | Name of the package |
| description | String | Description of the package |
| files | List<PackageFile> | All files in the package. More info on the PackageFile object is included below. |
PackageFile
| 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 |
...
| Attribute | Type | Required | Description |
|---|
| packageName | String (URL) | Yes | Name of the package, used to identify the package being updated. The name cannot be modified after the package is created |
| description | String | No | Description of the package |
| sortAll | Boolean | No | Whether or not the files in the package should be sorted by type. If this is true, sequence numbers for files will be ignored. This will default to false |
| addFileFilter | String | No | A filter to add all files containing this string |
| files | List<PackageFile> | No | All files in the package. Any files in the package before this request will be deleted and replaced by the files in the request. More info on the PackageFile object is included below. |
PackageFile
| Attribute | Type | Required | Description |
|---|
| filePath | String | Yes | Fully qualified path of the file |
| sequenceNumber | Integer | No | Order placement of this file in the package. Sequence numbers must be provided for all or none of the files in the package JSON. If sequence numbers aren't provided, the order of the files will be based on either object type, if the sortAll flag is true, or based on the order of the files in the request. |
...
| Attribute | Type | Description |
|---|
| name | String | Name of the package |
| description | String | Description of the package |
| files | List<PackageFile> | All files in the package. More info on the PackageFile object is included below. |
PackageFile
| 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 |
...
Back to Top
...
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 | Required | Description |
|---|
| packageName | String (URL) | Yes | Name of the package, used to identify the package being updated. The name cannot be modified after the package is created |
| description | String | No | Description of the package |
| sortAll | Boolean | No | Whether or not the files in the package should be sorted by type. If this is true, sequence numbers for files will be ignored. This will default to false |
| addFileFilter | String | No | A filter to add all files containing this string |
| files | List<PackageFile> | No | All files in the package. Any new files will be appended to files already in the package. More info on the PackageFile object is included below |
PackageFile
| Attribute | Type | Required | Description |
|---|
| filePath | String | Yes | Fully qualified path of the file |
| sequenceNumber | Integer | No | Order placement of this file in the package. Sequence numbers must be provided for all or none of the files in the package JSON. If sequence numbers aren't provided, the order of the files will be based on either object type, if the sortAll flag is true, or based on the order of the files in the request |
...
| Attribute | Type | Description |
|---|
| name | String | Name of the package |
| description | String | Description of the package |
| files | List<PackageFile> | All files in the package. More info on the PackageFile object is included below. |
PackageFile
| 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 |
...