Login | Join Now
  • CUBiT API: ProfileGetPkglist

    Product:
    CUBiT

    Component:
    CUBiT Web Services

    Summary:

    List packages associated with a particular version or revision of a profile.



     

    1.1. Description

    List packages associated with a particular version or revision of a profile. If neither are set, the latest (HEAD) revision of the profile is selected. You must have permissions to view the profile in order to retrieve a package listing. The profile must either be public, or you must be a valid user in the project that owns the profile.

    1.2. URL

    /cubit_api/1/getpkglist

    1.3. Authentication

    This method requires authentication using an API key.

    1.4. Parameters

    	output ( zero or once )
    		String. Ouput mode. 'txt' or 'xml' 
    		Type: String
    	profile ( Required, once )
    		Profile to get package list for. 
    		Type: String
    	revision ( zero or once )
    		Integer. Revision of profile to get package list for. 
    		Type: Integer
    	sig ( Required, once )
    		API authentication hash signature. 
    		Type: String
    	userid ( Required, once )
    		The login name of the user initiating the request. 
    		Type: String
    	version ( zero or once )
    		Integer. Version of profile to get package list for. 
    		Type: Integer
    

    1.5. Example Response

    (output='xml'):

    	<?xml version='1.0'?>
    	<cubit version='1'>
    	  <package version="1.2.3">pkgname1</package>
    	  <package version="4.5.6">pkgname2</package>
    	  <package version="7.8.9">pkgname3</package>
    	</cubit>
    	
    	(output='txt'):
    	pkg1  1.2.3
    	pkg2  4.5.6
    	pkg3  7.8.9
    

    1.6. Response Codes

    • 200 - ok
    • 400 - Login failed / Insufficient permissions