| Info |
|---|
This API is available starting with version @5.2.0.1 |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"name": "ALM-150",
"description": null,
"files": [
{
"filePath": "/sql/XXHR_BIPUB_REP_PKG.pls",
"objectType": "DB Objects (SQLs)",
"sequenceNumber": 1
},
{
"filePath": "/sql/XXHR_BIPUB_REP_PKG.pkb",
"objectType": "DB Objects (SQLs)",
"sequenceNumber": 2
}
]
} |
...
POST
This POST service will create a new package with the same attributes as the given JSON object.
...
| Attribute | Type | Required | Description |
|---|---|---|---|
| filePath | String | Yes | Fully qualified path of the file as it appears on the Project Files and Packages screens |
| 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. |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "Creating a package using the Package REST API",
"name": "REST_Package",
"files": [
{
"filePath": "/java/xxt/oracle/apps/ak/xxperson/webui/managePersonCO.java",
"objectType": "Oracle Application Framework (OAF) JAVA",
"sequenceNumber": 1
},
{
"filePath": "/java/xxt/oracle/apps/ak/xxperson/server/xxPersonAM.xml",
"objectType": "Oracle Application Framework (OAF) JAVA",
"sequenceNumber": 2
},
{
"filePath": "/sql/XXHR_BIPUB_REP_PKG.pls",
"objectType": "DB Objects (SQLs)",
"sequenceNumber": 3
},
{
"filePath": "/sql/XXHR_BIPUB_REP_PKG.pkb",
"objectType": "DB Objects (SQLs)",
"sequenceNumber": 4
}
]
} |
...
PUT
This PUT service will replace all attributes of a given package with the attributes of the provided JSON request.
...
| Attribute | Type | Required | Description |
|---|---|---|---|
| filePath | String | Yes | Fully qualified path of the filethe file as it appears on the Project Files and Packages screens |
| 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. |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"name": "REST_Package",
"description": "This is the updated package",
"files": [
{
"filePath": "/java/xxt/oracle/apps/ak/xxperson/webui/managePersonCO.java",
"objectType": "Oracle Application Framework (OAF) JAVA",
"sequenceNumber": 1
},
{
"filePath": "/sql/XXHR_BIPUB_REP_PKG.pkb",
"objectType": "DB Objects (SQLs)",
"sequenceNumber": 2
},
{
"filePath": "/java/xxt/oracle/apps/ak/xxperson/server/xxPersonAM.xml",
"objectType": "Oracle Application Framework (OAF) JAVA",
"sequenceNumber": 3
}
]
} |
...
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 |
|---|---|---|---|
| filePath | String | Yes | Fully qualified path of the filethe file as it appears on the Project Files and Packages screens |
| 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 |
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"name": "REST_Package",
"description": "This is the updated package",
"files": [
{
"filePath": "/java/xxt/oracle/apps/ak/xxperson/webui/managePersonCO.java",
"objectType": "Oracle Application Framework (OAF) JAVA",
"sequenceNumber": 1
},
{
"filePath": "/sql/XXHR_BIPUB_REP_PKG.pls",
"sequenceNumber": 2
},
{
"filePath": "/sql/XXHR_BIPUB_REP_PKG.pkb",
"objectType": "DB Objects (SQLs)",
"sequenceNumber": 3
},
{
"filePath": "/java/xxt/oracle/apps/ak/xxperson/server/xxPersonAM.xml",
"objectType": "Oracle Application Framework (OAF) JAVA",
"sequenceNumber": 4
}
]
} |
...
DELETE
This method will delete a package with the given name in the given project. There is no response message. If package is not present (was already deleted), no error code will be returned.
...
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 |
...