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.
packageType	String	Type of the package (USER_MANAGED or DYNAMIC).
packageStatus	String	Package Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release.
packagePath	String	Path to package.xml. Only used for Salesforce projects.
includePath	String	Comma separated list of regular expressions that define which project files will be included. Applicable for DYNAMIC packages only.
excludePath	String	Comma separated list of regular expressions that define which project files will be excluded. Applicable for DYNAMIC packages only.
tests	String	Salesforce Tests. Only applies to Salesforce type partial deployment projects.
testLevel	String	Salesforce Test Level. Only applies to Salesforce type partial deployment projects.
versionSyntax	String	Version syntax of the package. Only applies to Salesforce type partial deployment projects.

...

Code Block

theme	Eclipse
title	Package 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
		}
	],
   "packageType": "USER_MANAGED",
   "packagePath": null,
   "packageStatus": "ACTIVE",
   "includePath" : null,
   "excludePath" : null,
   "tests": null,
   "testLevel": "NoTestRun",
   "versionSyntax": null
}

...

Attribute	Type	Required	Description
name	String	Yes	Name of the package
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. More info on the PackageFile object is included below.
packageStatus	String	No	Package 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.
packagePath	String	No	Path to package.xml. Only used for Salesforce projects.
packageType	String	No	Type of the package to create (DYNAMIC or USER_MANAGED). Default is USER_MANAGED if not specified.
includePath	String	No	Comma separated list of regular expressions that define which project files will be included. Applicable for DYNAMIC packages only.
excludePath	String	No	Comma separated list of regular expressions that define which project files will be excluded. Applicable for DYNAMIC packages only.
tests	String	No	Salesforce Tests. Only applies to Salesforce type partial deployment projects.
testLevel	String	No	Salesforce Test Level. Only applies to Salesforce type partial deployment projects.
versionSyntax	String	No	Version syntax of the package. Only applies to Salesforce type partial deployment projects.

...

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.
packageStatus	String	Package 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.
packagePath	String	Path to package.xml. Only used for Salesforce projects.
packageType	String	Type of the package (DYNAMIC or USER_MANAGED).
includePath	String	Comma separated list of regular expressions that define which project files will be included. Applicable for DYNAMIC packages only.
excludePath	String	Comma separated list of regular expressions that define which project files will be excluded. Applicable for DYNAMIC packages only.
tests	String	Salesforce Tests. Only applies to Salesforce type partial deployment projects.
testLevel	String	Salesforce Test Level. Only applies to Salesforce type partial deployment projects.
versionSyntax	String	Version syntax of the package. Only applies to Salesforce type partial deployment projects.

...

Code Block

theme	Eclipse
title	POST 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
		}
	],
  "packageStatus": "ACTIVE",
  "pacageTypepackagePath": "USER_MANAGED"null,
  "pacageType": "USER_MANAGED",
  "includePath": null,
  "excludePath": null,
  "tests": null,
  "testLevel": "NoTestsRun",
  "versionSyntax": null
}

...

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
packageStatus	String	Yes	Package Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release.
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.
packageType	String	No	Type of the package (DYNAMIC or USER_MANAGED). The default is USER_MANAGED if not specified.
packagePath	String	No	Path to package.xml. Only used for Salesforce projects.
includePath	String	No	Comma separated list of regular expressions that define which project files will be included. Applicable for DYNAMIC packages only.
excludePath	String	No	Comma separated list of regular expressions that define which project files will be excluded. Applicable for DYNAMIC packages only.
tests	String	No	Salesforce Tests. Only applies to Salesforce type partial deployment projects.
testLevel	String	No	Salesforce Test Level. Only applies to Salesforce type partial deployment projects.
versionSyntax	String	No	Version syntax of the package. Only applies to Salesforce type partial deployment projects.

...

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.
packageStatus	String	Package Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release.
packageType	String	Type of the package (DYNAMIC or USER_MANAGED).
packagePath	String	Path to package.xml. Only used for Salesforce projects.
includePath	String	Comma separated list of regular expressions that define which project files will be included. Applicable for DYNAMIC packages only.
versionSyntax	String	Version syntax of the package. Only applies to Salesforce type partial deployment projects.
tests	String	Salesforce Tests. Only applies to Salesforce type partial deployment projects.
testLevel	String	Salesforce Test Level. Only applies to Salesforce type partial deployment projects.
versionSyntax	String	Version syntax of the package. Only applies to Salesforce type partial deployment projects.

...

Code Block

theme	Eclipse
title	Package 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",
   "packageType": "USER_MANAGED",
   "packagePath": null,
   "includePath": null,
   "excludePath": null,
   "tests": null,
   "testLevel": "NoTestsRun",
   "versionSyntax": null
}

...

Code Block

theme	Eclipse
title	Package 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",
   "packageType": "USER_MANAGED",
   "packagePath": null,
   "includePath": null,
   "excludePath": null,
   "tests": null,
   "testLevel": "NoTestsRun",
   "versionSyntax": null
}

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

title	API URL

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
packageStatus	String	No	Package Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release.
packageType	String	No	Type of the package (DYNAMIC or USER_MANAGED).
packagePath	String	No	Path to package.xml. Only used for Salesforce projects.
includePath	String	No	Comma separated list of regular expressions that define which project files will be included. Applicable for DYNAMIC packages only.
excludePath	String	No	Comma separated list of regular expressions that define which project files will be excluded. Applicable for DYNAMIC packages only.
tests	String	No	Salesforce Tests. Only applies to Salesforce type partial deployment projects.
testLevel	String	No	Salesforce Test Level. Only applies to Salesforce type partial deployment projects.
versionSyntax	String	No	Version syntax of the package. Only applies to Salesforce type partial deployment projects.

...

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.
packageStatus	String	Package Status. Possible values (ACTIVE, COMPLETED, INACTIVE). Completed packages can not be modified and only active packages can be added to a release.
packageType	String	Type of the package (DYNAMIC or USER_MANAGED).
packagePath	String	Path to package.xml. Only used for Salesforce projects.
includePath	String	Comma separated list of regular expressions that define which project files will be included. Applicable for DYNAMIC packages only.
excludePath	String	Comma separated list of regular expressions that define which project files will be excluded. Applicable for DYNAMIC packages only.
tests	String	Salesforce Tests. Only applies to Salesforce type partial deployment projects.
testLevel	String	Salesforce Test Level. Only applies to Salesforce type partial deployment projects.
versionSyntax	String	Version syntax of the package. Only applies to Salesforce type partial deployment projects.

...

Code Block

theme	Eclipse
title	Package 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",
   "packageType": "USER_MANAGED",
   "packagePath": null,
   "includePath": null,
   "excludePath": null,
   "tests": null,
   "testLevel": "NoTestsRun",
   "versionSyntax": null
}

...

Code Block

theme	Eclipse
title	Package PUT Receive JSON

{
   "name": "REST_Package",
   "description": "This is the updated package",
   "files": [
		{
			"filePath": "/sql/XXHR_BIPUB_REP_PKG.pls",
			"sequenceNumber": 2
		}
	],
   "packageStatus": "ACTIVE",
   "packageType": "USER_MANAGED",
   "packagePath": null,
   "includePath": null,
   "excludePath": null
}

...

Code Block

theme	Eclipse
title	Package 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",
  "packageType": "USER_MANAGED",
  "packagePath": null,
  "includePath": null,
  "excludePath": null
  "tests": null,
  "testLevel": "NoTestsRun",
  "versionSyntax": null
}

...

Versions Compared

Old Version 1

New Version 2

Key

PATCH

Page Comparison

Versions Compared

Old Version 1

New Version 2

Key

PATCH