Skip to main content

Version: 21.11

GET Application Package List

Return the list of application packages for an organization, sorted by name.

info

The Application Package REST API Overview provides an introduction to this REST API, including information about:

  • Security (authentication and authorization)

Request

HTTP request

GET https://<JM_SERVER>/manager/secure/rest/application-package/v1/<CLIENT_CODE>

The HTTP request URL includes the client code of the organization for which application packages are to be listed.

Parameters

This request takes no parameters.

Request body

Do not supply a request body for this operation.

Example

An example GET Application Package List request is shown below.

GET https://transact.maguire.com/manager/secure/rest/application-package/v1/maguire

Response

If successful, this operation returns a response with a HTTP 200 OK status code.

Response structure

The GET Application Package List operation returns application package value objects. An example response is included below.

Application Package

AttributeDescription
applicationNameString
The name of the application package.
clientCodeString
The client code of the organization owning the application package.
clientNameString
The name of the organization owning the application package.
createdAtDate
The application package creation date.
createdByString
The login name of the user who created the application package.
deliveryChannelsList of Delivery Channel value objects
The list of delivery channels associated with the application package.
descriptionString
A description of the application package.
formsList of Form value objects
The list of forms associated with the application package.
idLong
The OID of the application package.
lastModifiedAtDate
The last modified date of the application package.
lastModifiedByString
The login name of the user who last modified the application package.
organizationPropertiesList of Organization Property value objects
The list of organization properties associated with the application package.
serviceConnectionsList of Service Connection value objects
The list of service connections associated with the application package.
serviceDefinitionsList of Service Definition value objects
The list of service definitions associated with the application package.

Delivery Channel

AttributeDescription
deliveryMethodString
The delivery method (e.g. Delivery Process).
descriptionString
The description for the delivery channel.
nameString
The name of the delivery channel, unique within the organization.

Form

AttributeDescription
clientFormCodeString
The unique form code for this form.
descriptionString
The form description.
nameString
The form name, unique within the organization.

Organization Property

AttributeDescription
dataTypeString
The data type of the property; for example, String, HTML, Image.
propertyNameString
The name of the property; for example, URL.
valueString
The property value; for example, http://www.example.com.

Service Connection

AttributeDescription
clientCodeString
The client code of the organization that the service connection belongs to (if any).
nameString
The name of the service connection.
serverTypeString
The server type; for example, AWS S3.

Service Definition

AttributeDescription
descriptionString
The description for the service.
nameString
The name of the service definition.
typeString
The service type; for example, Dynamic Data.
versionNumberInteger
The version number of the service definition.

Example

An example successful response is shown below.

[
{
"id": 8,
"applicationName": "My Application 1",
"createdAt": "2013-12-23T00:00+1100",
"createdBy": "admin1",
"description": "This is the main application.",
"clientCode": "maguire",
"clientName": "Maguire",
"forms": [
{
"clientFormCode": "basic-form",
"description": "This is a basic form that can be hosted by SFM. It is available as HTML and PDF and also includes a PDF receipt.",
"name": "Basic Form - PDF"
},
{
"clientFormCode": "pf-maguire",
"name": "Payment Form"
},
{
"clientFormCode": "spdf-maguire",
"name": "Static PDF Form"
}
],
"organizationProperties": [
{
"dataType": "Image",
"propertyName": "Logo",
"value": "4.jpg"
},
{
"dataType": "String",
"propertyName": "URL",
"value": ""
},
{
"dataType": "String",
"propertyName": "Client Property maguire",
"value": "This is a test property value."
},
{
"dataType": "HTML",
"propertyName": "Additional Services",
"value": ""
}
],
"deliveryChannels": [
{
"deliveryMethod": "Delivery Process",
"description": "",
"name": "Shredder"
},
{
"deliveryMethod": "Delivery Process",
"description": "",
"name": "Client Process Delivery"
}
],
"serviceConnections": [
{
"clientCode": "maguire",
"name": "JBoss Maguire",
"serverType": "JBoss"
}
],
"serviceDefinitions": [
{
"description": "Provides form lookup form data service by calling a configurable Groovy script",
"name": "Client Service 2",
"type": "Dynamic Data",
"versionNumber": 1
},
{
"description": "Provides a Groovy script based submission delivery process.",
"name": "Export Groovy Delivery Process",
"type": "Delivery Process",
"versionNumber": 1
},
{
"description": "",
"name": "Client Service 1",
"type": "Receipt Number",
"versionNumber": 3
},
{
"description": "",
"name": "Client Service 1",
"type": "Receipt Number",
"versionNumber": 4
}
]
},
{
"id": 2,
"applicationName": "My Application 2",
"createdAt": "2013-12-23T00:00+1100",
"createdBy": "admin2",
"description": "",
"clientCode": "maguire",
"clientName": "Maguire",
"forms": [
{
"clientFormCode": "pf-maguire",
"name": "Payment Form"
}
],
"deliveryChannels": [],
"serviceDefinitions": [
{
"description": "Provides form lookup form data service by calling a configurable Groovy script",
"name": "Client Service 4",
"type": "Dynamic Data",
"versionNumber": 1
},
{
"description": "",
"name": "Client Service 1",
"type": "Receipt Number",
"versionNumber": 1
},
{
"description": "",
"name": "Client Service 1",
"type": "Receipt Number",
"versionNumber": 4
},
{
"description": "Demonstration payment gateway card payment service.",
"name": "Private Demo Card Payment",
"type": "Payment Gateway",
"versionNumber": 1
}
]
}
]