RetrieveSoftwarePackage

SoftwareService / RetrieveSoftwarePackage

Description: Retrieve Software packages

URL: http://{your-server-url}/api/v2/core/software/packages

Method: GET

Token Required: True

Request Headers:

token: {token}
content-type: application/json or content-type: application/xml

Request Query Parameters:

Parameter	Type	Nullable	Description
typeids	int	True	Comma seperated values, e.g. typeids=1,3
resourcescope	string	True	Comma seperated values, e.g. resourcescope=portal,network
ids	string	True	comma separated values, eg. ids=1,2,3
names	string	True	Comma seperated values, e.g. names=package1,package22
versions	string	True	Comma seperated values, e.g. names=1.0.0,2.0.1
sort	string	True	sorting fields: id, createddate,typeid,deprecate. Comma seperated values, unary negative to imply descending sort order, e.g. sort=-id
page	int	True	page number
rpp	int	True	records per page, default = 50, max = 500

Example: http://{your-server-url}/api/v2/core/software/packages?typeids=100&resourcescope=string&ids=string

Response:

Type: Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Software.SoftwareResponse

Parameter	Type
Response.TotalCount	int
Response.SoftwarePackages	Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Software.SoftwarePackage[]
Response.CurrentPage	int
Response.TotalPages	int
Response.Rpp	int

The following is an example response Xml body:

<SoftwareResponse xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages.AppSpaceIntegration.v1.Software" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <DebugMessage xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">String</DebugMessage>
  <Errors xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">
    <Error>
      <Code>String</Code>
      <Message>String</Message>
      <StackTrace>String</StackTrace>
    </Error>
  </Errors>
  <Status xmlns="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Messages">Success</Status>
  <CurrentPage>123</CurrentPage>
  <Rpp>123</Rpp>
  <SoftwarePackages xmlns:a="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO.AppSpaceIntegration.v1.Software">
    <a:SoftwarePackage>
      <a:CreatedDate>2015-08-25T17:54:28.705756Z</a:CreatedDate>
      <a:DeprecatedDate>2015-08-25T17:54:28.7067556Z</a:DeprecatedDate>
      <a:Id>123</a:Id>
      <a:IsCommitted>true</a:IsCommitted>
      <a:IsDeprecated>true</a:IsDeprecated>
      <a:MetaData xmlns:b="http://schemas.datacontract.org/2004/07/Nexus.AppSpace.Service.Contract.Model.DTO">
        <b:KeyValuePair>
          <b:Key>String</b:Key>
          <b:Value>String</b:Value>
        </b:KeyValuePair>
      </a:MetaData>
      <a:Name>String</a:Name>
      <a:Size>0</a:Size>
      <a:SoftwarePackageTypeId>123</a:SoftwarePackageTypeId>
      <a:UpdatedDate>2015-08-25T17:54:28.7067556Z</a:UpdatedDate>
      <a:Version>String</a:Version>
    </a:SoftwarePackage>
  </SoftwarePackages>
  <TotalCount>123</TotalCount>
  <TotalPages>123</TotalPages>
</SoftwareResponse>

The following is an example response Json body:

{
	"DebugMessage":"String",
	"Errors":[
		{
			"Code":"String",
			"Message":"String",
			"StackTrace":"String"
		}
	],
	"Status":1,
	"CurrentPage":123,
	"Rpp":123,
	"SoftwarePackages":[
		{
			"CreatedDate":"\/Date(1440525268705)\/",
			"DeprecatedDate":"\/Date(1440525268706)\/",
			"Id":123,
			"IsCommitted":true,
			"IsDeprecated":true,
			"MetaData":[
				{
					"Key":"String",
					"Value":"String"
				}
			],
			"Name":"String",
			"Size":0,
			"SoftwarePackageTypeId":123,
			"UpdatedDate":"\/Date(1440525268706)\/",
			"Version":"String"
		}
	],
	"TotalCount":123,
	"TotalPages":123
}