Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Info

This API is available starting with version @5.2.0.1

...

AttributeTypeDescription
nameStringName of the package
descriptionStringDescription of the package
filesList<PackageFile>All files in the package. More info on the PackageFile object is included below.
packageStatusStringPackage Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release.

PackageFile

AttributeTypeDescription
filePathStringFully qualified path of the file
objectTypeStringType of the object
sequenceNumberIntegerOrder placement of this file in the package

...

Code Block
themeEclipse
titlePackage GET Return JSON
{
   "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
		}
	],
   "packageStatus" "ACTIVE"
}

Back to Top

...

POST

This POST service will create a new package with the same attributes as the given JSON object.

...

AttributeTypeRequiredDescription
nameStringYesName of the package
descriptionStringNoDescription of the package
sortAllBooleanNoWhether 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
addFileFilterStringNoA filter to add all files containing this string
filesList<PackageFile>NoAll files in the package. More info on the PackageFile object is included below.

...

packageStatus
Attribute
String 
TypeRequiredDescription
NoPackage Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release. Defaults to Active.

PackageFile

AttributeTypeRequiredDescription
filePathStringYesFully qualified path of the file as it appears on the Project Files and Packages screens
sequenceNumberIntegerNoOrder 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.

...

AttributeTypeDescription
nameStringName of the package
descriptionStringDescription of the package
filesList<PackageFile>All files in the package. More info on the PackageFile object is included below.
packageStatusStringPackage Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release. Defaults to Active.

PackageFile

AttributeTypeDescription
filePathStringFully qualified path of the file
objectTypeStringType of the object
sequenceNumberIntegerOrder placement of this file in the package

...

Code Block
themeEclipse
titlePOST JSON
{
   "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
		}
	],
  "packageStatus": "ACTIVE"
}

Back to Top

...

PUT

This PUT service will replace all attributes of a given package with the attributes of the provided JSON request.

...

AttributeTypeRequiredDescription
packageNameString (URL)YesName of the package, used to identify the package being updated. The name cannot be modified after the package is created. The name cannot be modified after the package is created
packageStatusString YesPackage Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release.
descriptionStringNoDescription of the package
sortAllBooleanNoWhether 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
addFileFilterStringNoA filter to add all files containing this string
filesList<PackageFile>NoAll 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.

...

AttributeTypeDescription
nameStringName of the package
descriptionStringDescription of the package
filesList<PackageFile>All files in the package. More info on the PackageFile object is included below.
packageStatusStringPackage Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release.

PackageFile

AttributeTypeDescription
filePathStringFully qualified path of the file
objectTypeStringType of the object
sequenceNumberIntegerOrder placement of this file in the package

...

Code Block
themeEclipse
titlePackage PUT JSON
{
   "description": "Creating a package using the Package REST API",
   "name": "REST_Package",
   "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
		},
		{
			"filePath": "/java/xxt/oracle/apps/ak/xxperson/webui/managePersonCO.java",
			"objectType": "Oracle Application Framework (OAF) JAVA",
			"sequenceNumber": 3
		},
		{
			"filePath": "/java/xxt/oracle/apps/ak/xxperson/server/xxPersonAM.xml",
			"objectType": "Oracle Application Framework (OAF) JAVA",
			"sequenceNumber": 4
		}
	]],
  "packageStatus": "ACTIVE"
}

When we run a PUT request at the URL http://host:port/flexdeploy/rest/v1/project/14935/package/REST_Package, and the PUT request receives the following JSON package object,

Code Block
themeEclipse
titlePackage PUT Receive JSON
{
	"description": "This is the updated package",
	"sortAll": false,
    "addFileFilter": null,
	"files": [
		{
			"filePath": "/java/xxt/oracle/apps/ak/xxperson/webui/managePersonCO.java"
		},
		{
			"filePath": "/sql/XXHR_BIPUB_REP_PKG.pkb"
		},
		{
			"filePath": "/java/xxt/oracle/apps/ak/xxperson/server/xxPersonAM.xml"
		}
	],
   "packageStatus": "ACTIVE"
}

The PUT request would then update the package and return the following JSON package object:

Code Block
themeEclipse
titlePackage PUT Return JSON
{
	"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
		}
	],
   "packageStatus": "ACTIVE"
}

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
titleAPI URL

http://host:port/flexdeploy/rest/v1/project/{projectId}/package/{packageName}

...

AttributeTypeRequiredDescription
packageNameString (URL)YesName of the package, used to identify the package being updated. The name cannot be modified after the package is created
descriptionStringNoDescription of the package
sortAllBooleanNoWhether 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
addFileFilterStringNoA filter to add all files containing this string
filesList<PackageFile>NoAll files in the package. Any new files will be appended to files already in the package. More info on the PackageFile object is included belowobject is included below
packageStatusString NoPackage Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release.

PackageFile

AttributeTypeRequiredDescription
filePathStringYesFully qualified path of the file as it appears on the Project Files and Packages screens
sequenceNumberIntegerNoOrder 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

...

AttributeTypeDescription
nameStringName of the package
descriptionStringDescription of the package
filesList<PackageFile>All files in the package. More info on the PackageFile object is included below.
packageStatusStringPackage Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release.

PackageFile

AttributeTypeDescription
filePathStringFully qualified path of the file
objectTypeStringType of the object
sequenceNumberIntegerOrder placement of this file in the package

...

Code Block
themeEclipse
titlePackage POST JSON
{
	"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
		}
	],
  "packageStatus": "ACTIVE"
}

When we run a PATCH request at the URL http://host:port/flexdeploy/rest/v1/project/14935/package/REST_Package, and the PATCH request receives the following JSON package object,

...

Code Block
themeEclipse
titlePackage PUT Return JSON
{
	"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
		}
	],
  "packageStatus": "ACTIVE"
}

Back to Top

...

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.

...