Applications API

Use the Applications API to request metadata and statistical data for the native iOS, Android, and Windows applications stored in the EASE database for your organization.

You can request application data for:

  • A specific application.
  • All App Catalogs in your organization.
  • All native applications in your the organization.
  • All native applications available to a specific user.

Note

The applications available to a user depend on the user’s role and which groups he is assigned to. For example, if a user has the Developer role and is a member of Group A he will only see applications assigned to Group A, but not to Group B or Group C.

Users with Administrator and App Manager roles can view all apps in their organization. For more information, see Roles.

You can also use the Applications API to perform the following tasks:

  • Enable an application
  • Disable an application
  • Delete an application
  • Add screenshots
  • Delete screenshots
  • Download a native application’s binary file
  • Upload an application icon
  • Add or delete a banner image that will display in a custom App Catalog
  • List all versions of an application

Note

To add an update of an application to EASE, use the EASE Publishing API. For instructions, see the EASE Publishing API Guide.

EASE assigns a unique ID to each application you add to EASE. With the Publishing API, this ID is returned as an appID. With other API resources, it is returned as either an app_psk or app_id (or both). When you send a request to any REST API resources where you need to specify an ID for an application, you can send the appID, app_id, or app_psk; EASE accepts the value of any of these parameters.

Resources

GET /v1/applications/

Attention

There is a newer version of this resource available: GET /v2/applications/. This v1 version will be deprecated in Q3 of 2017. If you currently interface with this v1 resource, please modify your code to point to the latest V2 version. If you have any questions, contact support@apperian.com.

List All Applications

Requires user context. Authenticate as a valid EASE user.

Returns data about all the native applications stored in the EASE database for the authenticated user’s organization. To identify whether an application is enabled, look at the value of the status parameter in the response: 0 indicates disabled; 1 indicates enabled.

Note

For each application, the response includes a direct_download_binary_url field. Send a GET request to the URL provided in that field to download the app’s binary file. For more information, see GET /downloads/direct/applications/<app_id>.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/
Europe https://eu01ws.apperian.eu/v1/applications/

URL Parameters

When you send a GET request to this resource, you can specify URL parameters to search, sort, and paginate the JSON data returned in the response. For more information, see Controlling GET Responses.

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/ --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

This example shows a portion of the response. With the status parameter, 0 indicates disabled; 1 indicates enabled.

{
  "applications": [
    {
      "operating_system": 1,
      "update_compliance_period_in_days": null,
      "url_scheme": "",
      "form_factor": 3,
      "long_description": "Come on. Get organized! Use this app to manage your TO DO list, and to sync up with project team members.",
      "is_adhoc": false,
      "platform": null,
      "is_hybrid": false,
      "required_by": "3099-12-31T00:00:00+00:00",
      "os_version": null,
      "is_app_catalog": false,
      "latest_version": 106,
      "version": {
        "psk": 106,
        "posted_date": "2016-03-22T13:42:03.678841+00:00",
        "description": "This is the newest version!",
        "version_num": "2.0",
        "verification_status": 0,
        "latest_install_file": 116,
        "release_date": "2016-03-22T13:42:03.678841+00:00",
        "required": false,
        "mdm_id": null,
        "required_by": "9999-12-31T23:59:59.999999",
        "mdm_status": 0,
        "app_psk": 75,
        "wrap_status": 2,
        "signstatus": 0,
        "veracode_verification_status": 0,
        "kryptowire_verification_status": 0,
        "notify_users": false,
        "app_name": "Actions",
        "install_file": {
          "file_type_constant": "INSTALLEXE",
          "apperian_wrapper_version": 17,
          "veracode_verification_id": null,
          "kryptowire_verification_id": null,
          "hash_type": "none",
          "hash_value": null,
          "description": null,
          "app_psk": 75,
          "size": 965423,
          "until": "9999-12-31T23:59:59.999999",
          "psk": 116,
          "complete": false,
          "appthority_verification_id": null,
          "deleted": false,
          "expires": null,
          "mime": "application/itunes+zip",
          "path": "org_11/iphone_75/version_106/policy_2/Actions.ipa",
          "name": null,
          "created": "2016-03-22T14:04:12.120484+00:00",
          "version_psk": 106,
          "checksum": null,
          "sign_credentials_psk": null,
          "action": "wrap",
          "binary_metadata": null
        }
      },
      "reviews_enabled": true,
      "short_description": "Manage your TO DO list",
      "screenshot_path3": "",
      "screenshot_path1": "",
      "type": 0,
      "screenshot_path4": "",
      "screenshot_path5": "",
      "status": 0,
      "psk": 75,
      "sort_weight": 1000,
      "no_auth_delivery_enabled": true,
      "deleted": null,
      "icon_path": "org_11/iphone_75/Actions_57.png",
      "is_email_config_profile": false,
      "custom_metadata": null,
      "add_to_start": false,
      "screenshot_path2": "",
      "tablet_screenshot_path5": "",
      "min_os_version": "7.1",
      "bundle_id": "com.apperian.Actions",
      "banner_image_url": null,
      "categories": [
        {
          "psk": 244,
          "org_psk": 11,
          "constant": "COMPANY",
          "name": "Company Wide",
          "icon_path": "/icons/categories/company_wide.png",
          "description": ""
        }
      ],
      "tablet_screenshot_path3": "",
      "tablet_screenshot_path4": "",
      "tablet_screenshot_path2": "",
      "tablet_screenshot_path1": "",
      "direct_download_binary_url":
            "https://na01ws.apperian.com/v1/downloads/direct/applications/8f92x99Kw8qfHxeDkcK8fA",
      "required": false,
      "push_enabled": false
    },
    {
      "operating_system": 102,
      "update_compliance_period_in_days": null,
      "url_scheme": "",
      "form_factor": 3,
      "long_description": "Access all things related to Example Company benefits.",
      "is_adhoc": false,
      "platform": null,
      "is_hybrid": false,
      "required_by": "9999-12-31T23:59:59.999999",
      "os_version": null,
      "is_app_catalog": false,
      "latest_version": 109,
      "version": {
        "psk": 109,
        "posted_date": "2016-03-22T15:24:13.668336+00:00",
        "description": "The latest version",
        "version_num": "1.0",
        "verification_status": 0,
        "latest_install_file": 143,
        "release_date": "2016-03-22T15:24:13.668336+00:00",
        "required": false,
        "mdm_id": null,
        "required_by": "9999-12-31T23:59:59.999999",
        "mdm_status": 0,
        "app_psk": 76,
        "wrap_status": 1,
        "signstatus": 0,
        "veracode_verification_status": 0,
        "kryptowire_verification_status": 0,
        "notify_users": true,
        "app_name": "Benefits",
        "install_file": {
          "file_type_constant": "INSTALLEXE",
          "apperian_wrapper_version": 20,
          "veracode_verification_id": null,
          "kryptowire_verification_id": null,
          "hash_type": "none",
          "hash_value": null,
          "description": null,
          "app_psk": 76,
          "size": 2649824,
          "until": "9999-12-31T23:59:59.999999",
          "psk": 143,
          "complete": false,
          "appthority_verification_id": null,
          "deleted": false,
          "expires": null,
          "mime": "application/vnd.android.package-archive",
          "path": "org_11/android_76/version_109/signed/ASTRO_File_Manager_2.5.2.apk",
          "name": null,
          "created": "2016-03-22T18:14:16.418391+00:00",
          "version_psk": 109,
          "checksum": "e16f266dcdbf600acd53f7a2bf55babe1d36c896a7c8e4c687a2d012bf6dd297",
          "sign_credentials_psk": null,
          "action": "sign_with_package",
          "binary_metadata": null
        }
      },
      "reviews_enabled": true,
      "short_description": "Example Company Benefits",
      "screenshot_path3": "",
      "screenshot_path1": "",
      "type": 3,
      "screenshot_path4": "",
      "screenshot_path5": "",
      "status": 0,
      "psk": 76,
      "sort_weight": 1000,
      "no_auth_delivery_enabled": true,
      "deleted": null,
      "icon_path": "org_11/android_76/appicon.png",
      "is_email_config_profile": false,
      "custom_metadata": null,
      "add_to_start": false,
      "screenshot_path2": "",
      "tablet_screenshot_path5": "",
      "min_os_version": "3",
      "bundle_id": "com.example.benefits",
      "banner_image_url": null,
      "categories": [
        {
          "psk": 244,
          "org_psk": 11,
          "constant": "COMPANY",
          "name": "Company Wide",
          "icon_path": "/icons/categories/company_wide.png",
          "description": ""
        }
      ],
      "tablet_screenshot_path3": "",
      "tablet_screenshot_path4": "",
      "tablet_screenshot_path2": "",
      "tablet_screenshot_path1": "",
      "direct_download_binary_url":
            "https://na01ws.apperian.com/v1/downloads/direct/applications/6fCatAVv29awTRDAudfL0A",
      "required": false,
      "push_enabled": false
    }
  ],
  "total_available": 2
}
GET /v1/applications/(app_psk)

Attention

There is a newer version of this resource available: GET /v2/applications/<app_id>/. This v1 version will be deprecated in Q3 of 2017. If you currently interface with this v1 resource, please modify your code to point to the latest V2 version. If you have any questions, contact support@apperian.com.

List Data for a Specific Application

Requires user context. Authenticate as a valid EASE user.

Returns data about the specified application. Specify the app with app_psk. The app_psk for each app in your organization is included in the data returned by the GET /applications resource.

The response lists many details about the application, including its:

Direct Download URL: Send a GET request to the URL provided in the direct_download_binary_url field to download the app’s binary.

Signing Status: After you send a PUT request to /applications/<app_psk>/credentials/<credentials_psk>, use the following fields to monitor signing status:

Field Description
signing_status

The current status of the signing process. Valid values include:

  • in_progress
  • signed
  • cancelled
  • error

Note that a signstatus field is also returned, but can be ignored. It returns a number value for one of the statuses above.

signing_status_details

Additional information about the signing status. This field is useful primarily when the signing status is error. For example:

The cert or profile is expired and will not run on any device.

See the Example Response below to view all the data returned about each app. To identify whether an application is enabled, look at the value of the status parameter: 0 indicates disabled; 1 indicates enabled.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<int:app_psk>
Europe https://eu01ws.apperian.eu/v1/applications/<int:app_psk>

URL Parameters

app_psk
(Required) Unique ID of the app. DATA TYPE: integer

Header Parameters

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None.

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/123 --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

Note that the following response includes custom metadata that was specified for the app using the PUT /applications/<app_psk> API. The status parameter has a value of 0, which indicates that the app is disabled.

{
      "application": {
        "operating_system": 1,
        "update_compliance_period_in_days": null,
        "url_scheme": "",
        "form_factor": 3,
        "long_description": "Come on. Get organized! Use this app to manage your TO DO list, and to sync up with project team members.",
        "is_adhoc": false,
        "platform": null,
        "is_hybrid": false,
        "required_by": "3099-12-31T00:00:00+00:00",
        "os_version": null,
        "is_app_catalog": false,
        "latest_version": 106,
        "version": {
          "psk": 106,
          "posted_date": "2016-03-22T13:42:03.678841+00:00",
          "description": "Latest version",
          "version_num": "2.0",
          "verification_status": 0,
          "latest_install_file": 116,
          "release_date": "2016-03-22T13:42:03.678841+00:00",
          "required": false,
          "mdm_id": null,
          "notify_users": false,
          "required_by": "9999-12-31T23:59:59.999999",
          "signing_status_details": "The application was signed successfully.",
          "signing_status": "signed",
          "app_psk": 75,
          "mdm_status": 0,
          "signstatus": 0,
          "veracode_verification_status": 0,
          "kryptowire_verification_status": 0,
          "wrap_status": 2,
          "install_file": {
            "file_type_constant": "INSTALLEXE",
            "apperian_wrapper_version": 17,
            "veracode_verification_id": null,
            "kryptowire_verification_id": null,
            "hash_type": "none",
            "hash_value": null,
            "description": null,
            "app_psk": 75,
            "size": 965423,
            "until": "9999-12-31T23:59:59.999999",
            "psk": 116,
            "complete": false,
            "appthority_verification_id": null,
            "deleted": false,
            "expires": null,
            "mime": "application/itunes+zip",
            "path": "org_11/iphone_75/version_106/policy_2/Actions.ipa",
            "name": null,
            "created": "2016-03-22T14:04:12.120484+00:00",
            "version_psk": 106,
            "checksum": null,
            "sign_credentials_psk": null,
            "action": "wrap",
            "binary_metadata": null
          }
        },
        "reviews_enabled": true,
        "short_description": "Manage your To DO list.",
        "screenshot_path3": "",
        "screenshot_path1": "",
        "type": 0,
        "screenshot_path4": "",
        "screenshot_path5": "",
        "status": 0,
        "psk": 75,
        "sort_weight": 1000,
        "no_auth_delivery_enabled": true,
        "deleted": null,
        "icon_path": "org_11/iphone_75/Actions_57.png",
        "is_email_config_profile": false,
        "custom_metadata": {
              "city": "Boston",
              "name": "Diane",
              "lastname": "Harrelson",
              "restaurants": "Cheers"
        },
        "add_to_start": false,
        "screenshot_path2": "",
        "tablet_screenshot_path5": "",
        "min_os_version": "7.1",
        "bundle_id": "com.apperian.Actions",
        "banner_image_url": null,
        "tablet_screenshot_path3": "",
        "tablet_screenshot_path4": "",
        "tablet_screenshot_path2": "",
        "tablet_screenshot_path1": "",
        "direct_download_binary_url":
            "https://na01ws.apperian.com/v1/downloads/direct/applications/8f92x99Kw8qfHxeDkcK8fA",
        "required": false,
        "push_enabled": false
      }
    }

For a list of messages that may be returned in the signing_status_details field, see Signing Status Messages.

POST /v1/applications/(app_psk)/screenshots/phone/(int: slot)/

Upload a Phone Screenshot for An Application

Requires administrator privileges. Authenticate as an EASE administrator.

You can associate screenshots with any native applications in your organization. These screenshots display on the details page for the application when a user views it in the App Catalog, and can be used to show examples of the app’s user interface or other images that will provide useful information about the app-similar to a user’s experience when viewing apps in a public app store.

Use this API resource to upload a screenshot as a multipart form that contains a single file. EASE supports PNG (.png) and JPEG (.jpg or .jpeg) formats. You can upload up to 10 screenshots, one at a time. Five phone screenshots and five tablet screenshots. When a user views the screenshots, the App Catalog will display only those files uploaded for the correct form factor (phone or tablet). The order in which screenshots display in the App Catalog is determined by a slot number (1-5) that you must specify as a URL parameter in the API request. If you add multiple screenshots for the same form factor to the same slot, the most recently added will overwrite those previously added.

In the EASE Portal, you can edit an application to view the screenshots associated with it. For instructions on editing an application, see Edit or Update an Application.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/screenshots/phone/<slot>
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/screenshots/phone/<slot>

phone adds a screenshot that will display when the App Catalog is running on a phone.

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer
slot
(Required) Order in which the screenshot will display on the app’s details page in the App Catalog. If you specify the same slot of a screenshot that is already stored for the same form factor (phone or tablet), the new file will overwrite the previously added file. DATA TYPE: integer Valid values: 1-5

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.
Content-Type
(Required) Specifies the content type of the body of data sent with the request. Set to: multipart/form-data

Form Parameters

screenshot
(Required) Specifies the screenshot file. The file must be in PNG (.png) or JPEG (.jpg or .jpeg) format and the filename cannot exceed 120 characters.

Data Parameters

None

Example Request

Use the -v (verbose) argument if you want to return detailed status of the request issued with curl. Without -v, a successful request returns a blank response.

curl -v https://ws-qaease.qa.apperian.com/applications/16776/screenshots/phone/1 -F "screenshot=@appimage.png" --header "X-Token:wBZ99s1fQpyK7tZ0bYAHdA"

Example Response

This is an example of a verbose response to a curl command. An HTTP 201 response indicates that the file was successfully uploaded.

*   Trying 192.237.212.215...
* Connected to ws-ease.apperian.com (192.237.212.215) port 443 (#0)
* TLS 1.2 connection using TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
* Server certificate: *.qa.apperian.com
* Server certificate: RapidSSL CA
* Server certificate: GeoTrust Global CA
> POST /applications/16776/screenshots/phone/1 HTTP/1.1
> Host: ws-qaease.qa.apperian.com
> User-Agent: curl/7.43.0
> Accept: */*
> X-Token:wBZ99s1fQpyK7tZ0bYAHdA
> Content-Length: 70281
> Expect: 100-continue
> Content-Type: multipart/form-data; boundary=------------------------2c7826b9f3e94b93
>
< HTTP/1.1 100 Continue
< HTTP/1.1 201 CREATED
< Date: Thu, 21 Jan 2016 23:58:50 GMT
< Server: Apache
< Content-Length: 0
< Access-Control-Allow-Origin: null
< Vary: Accept-Encoding
< Connection: close
< Content-Type: text/html; charset=utf-8
<
* Closing connection 0
POST /v1/applications/(app_psk)/screenshots/tablet/(int: slot)/

Upload a Tablet Screenshot for An Application

Requires administrator privileges. Authenticate as an EASE administrator.

You can associate screenshots with any native applications in your organization. These screenshots display on the details page for the application when a user views it in the App Catalog, and can be used to show examples of the app’s user interface or other images that will provide useful information about the app-similar to a user’s experience when viewing apps in a public app store.

Use this API resource to upload a screenshot as a multipart form that contains a single file. EASE supports PNG (.png) and JPEG (.jpg or .jpeg) formats. You can upload up to 10 screenshots, one at a time. Five phone screenshots and five tablet screenshots. When a user views the screenshots, the App Catalog will display only those files uploaded for the correct form factor (phone or tablet). The order in which screenshots display in the App Catalog is determined by a slot number (1-5) that you must specify as a URL parameter in the API request. If you add multiple screenshots for the same form factor to the same slot, the most recently added will overwrite those previously added.

In the EASE Portal, you can edit an application to view the screenshots associated with it. For instructions on editing an application, see Edit or Update an Application.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/screenshots/tablet/<slot>
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/screenshots/tablet/<slot>

tablet adds a screenshot that will display when the App Catalog is running on a tablet.

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer
slot
(Required) Order in which the screenshot will display on the app’s details page in the App Catalog. If you specify the same slot of a screenshot that is already stored for the same form factor (phone or tablet), the new file will overwrite the previously added file. DATA TYPE: integer, Valid values: 1-5

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.
Content-Type
(Required) Specifies the content type of the body of data sent with the request. Set to: multipart/form-data

Form Parameters

screenshot
(Required) Specifies the screenshot file. The file must be in PNG (.png) or JPEG (.jpg or .jpeg) format and the filename cannot exceed 120 characters.

Data Parameters

None

Example Request

Use the -v (verbose) argument if you want to return detailed status of the request issued with curl. Without -v, a successful request returns a blank response.

curl -v https://ws-qaease.qa.apperian.com/applications/16776/screenshots/phone/1 -F "screenshot=@appimage.png" --header "X-Token:wBZ99s1fQpyK7tZ0bYAHdA"

Example Response

This is an example of a verbose response to a curl command. An HTTP 201 response indicates that the file was successfully uploaded.

*   Trying 192.237.212.215...
* Connected to ws-ease.apperian.com (192.237.212.215) port 443 (#0)
* TLS 1.2 connection using TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
* Server certificate: *.qa.apperian.com
* Server certificate: RapidSSL CA
* Server certificate: GeoTrust Global CA
> POST /applications/16776/screenshots/tablet/1 HTTP/1.1
> Host: ws-qaease.qa.apperian.com
> User-Agent: curl/7.43.0
> Accept: */*
> X-Token:wBZ99s1fQpyK7tZ0bYAHdA
> Content-Length: 70281
> Expect: 100-continue
> Content-Type: multipart/form-data; boundary=------------------------2c7826b9f3e94b93
>
< HTTP/1.1 100 Continue
< HTTP/1.1 201 CREATED
< Date: Thu, 21 Jan 2016 23:58:50 GMT
< Server: Apache
< Content-Length: 0
< Access-Control-Allow-Origin: null
< Vary: Accept-Encoding
< Connection: close
< Content-Type: text/html; charset=utf-8
<
* Closing connection 0
DELETE /v1/applications/(app_psk)/screenshots/phone/(int: slot)/

Delete an Application Phone Screenshot

Requires administrator privileges. Authenticate as an EASE administrator.

Use this API resource to delete a screenshot associated with an application. An application can have up to 10 screenshots: five phone screenshots and five table screenshots. Each screenshot is tied to a slot number that determines the order in which the screenshot displays in the App Catalog.

For more information on screenshot slots and how to upload screenshots for an application, see POST /applications/<app_psk>/screenshots/phone/<slot>.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/screenshots/phone/<slot>
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/screenshots/phone/<slot>

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer
slot

(Required) Specify the slot of the screenshot you want to delete. You can view a list with slot number of all the screenshots stored for an app by returning details about the app with the GET /applications/<app_psk> resource. DATA TYPE: integer,

Valid values: 1-5

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Form Parameters

None

Data Parameters

None

Example Request

Use the -v (verbose) argument if you want to return detailed status of the request issued with curl. Without -v, a successful request returns a blank response.

curl -v -X DELETE https://ws-qaease.qa.apperian.com/applications/16776/screenshots/phone/1 --header "X-Token:wBZ99s1fQpyK7tZ0bYAHdA"

Example Response

This is an example of a verbose response to a curl command. An HTTP 200 response indicates that the request was completed successfully.

*   Trying 192.237.212.215...
* Connected to ws-qaease.qa.apperian.com (192.237.212.215) port 443 (#0)
* TLS 1.2 connection using TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
* Server certificate: *.qa.apperian.com
* Server certificate: RapidSSL CA
* Server certificate: GeoTrust Global CA
> DELETE /applications/16776/screenshots/phone/1 HTTP/1.1
> Host: ws-qaease.qa.apperian.com
> User-Agent: curl/7.43.0
> Accept: */*
> X-Token:TWK-D2-tSyiJ_6pQSwmyvQ
>
< HTTP/1.1 200 OK
< Date: Fri, 22 Jan 2016 00:45:37 GMT
< Server: Apache
< Content-Length: 0
< Access-Control-Allow-Origin: null
< Vary: Accept-Encoding
< Connection: close
< Content-Type: text/html; charset=utf-8
<
* Closing connection 0
DELETE /v1/applications/(app_psk)/screenshots/tablet/(int: slot)/

Delete an Application Tablet Screenshot

Requires administrator privileges. Authenticate as an EASE administrator.

Use this API resource to delete a screenshot associated with an application. An application can have up to 10 screenshots: five phone screenshots and five table screenshots. Each screenshot is tied to a slot number that determines the order in which the screenshot displays in the App Catalog.

For more information on screenshot slots and how to upload screenshots for an application, see POST /applications/<app_psk>/screenshots/tablet/<slot>.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/screenshots/tablet/<slot>
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/screenshots/tablet/<slot>

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer
slot

(Required) Specify the slot of the screenshot you want to delete. You can view a list with slot number of all the screenshots stored for an app by returning details about the app with the GET /applications/<app_psk> resource. DATA TYPE: integer

Valid values: 1-5

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Form Parameters

None

Data Parameters

None

Example Request

Use the -v (verbose) argument if you want to return detailed status of the request issued with curl. Without -v, a successful request returns a blank response.

curl -v -X DELETE https://ws-qaease.qa.apperian.com/applications/16776/screenshots/phone/1 --header "X-Token:wBZ99s1fQpyK7tZ0bYAHdA"

Example Response

This is an example of a verbose response to a curl command. An HTTP 200 response indicates that the request was completed successfully.

*   Trying 192.237.212.215...
* Connected to ws-qaease.qa.apperian.com (192.237.212.215) port 443 (#0)
* TLS 1.2 connection using TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
* Server certificate: *.qa.apperian.com
* Server certificate: RapidSSL CA
* Server certificate: GeoTrust Global CA
> DELETE /applications/16776/screenshots/tablet/1 HTTP/1.1
> Host: ws-qaease.qa.apperian.com
> User-Agent: curl/7.43.0
> Accept: */*
> X-Token:TWK-D2-tSyiJ_6pQSwmyvQ
>
< HTTP/1.1 200 OK
< Date: Fri, 22 Jan 2016 00:45:37 GMT
< Server: Apache
< Content-Length: 0
< Access-Control-Allow-Origin: null
< Vary: Accept-Encoding
< Connection: close
< Content-Type: text/html; charset=utf-8
<
* Closing connection 0

List Related Media for an Application

Requires user context. Authenticate as a valid EASE user.

Returns the list of related media for the specified application. Specify the app with app_psk. The app_psk for each app in your organization is included in the data returned by the GET /applications resource.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/related_media/
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/related_media/

URL Parameters

app_psk
(Required) Unique ID assigned by EASE to the app. DATA TYPE: integer

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/123/related_media --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

In this example, there is one media file associated with the specified application.

{
     "related_media": [
       {
         "psk": 28481,
         "description": "How To Video",
         "upload_date": "2015-07-22T23:26:11.122131+00:00",
         "deleted": false,
         "parts_done": 1,
         "no_parts": 1,
         "file_type": "MEDIAVIDEO",
         "version": 22536,
         "mime": "video/mp4",
         "hash_type": "none",
         "complete": true,
         "created_date": "2015-07-22T23:26:11.122131+00:00",
         "app_psk": 2377,
         "author": "Michael Harrison",
         "path": "https://ws-ease.apperian.com/catalog/assets/org_20/iphone_2377/flicker.mp4",
         "hash_value": null,
         "size": 9656292
       }
     ]
}
GET /v1/applications/(app_psk)/stats/

List Download and Usage Count for a Specific Application

Requires user context. Authenticate as a valid EASE user.

Returns Download Count and Usage Count for an application during a specified statistical time period (start_date through end_date).

  • Download Count identifies the number of times the app was downloaded to a device during the statistical time period.
  • Usage Count identifies the number of times the app was used during the statistical time period. This count is calculated only if the app is wrapped with the App Usage policy. The count is incremented when a user opens the app, brings the app to the foreground, or returns to the app from the lock screen.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<int:app_psk>/stats/
Europe https://eu01ws.apperian.eu/v1/applications/<int:app_psk>/stats/

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer
start_date
(Required) Start date for the statistical period. For example: 2014-01-15 DATA TYPE: date in yyyy-mm-dd format
end_date
(Required) End date for the statistical period. For example: 2014-01-30 DATA TYPE: date in yyyy-mm-dd format

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

Be sure to surround the URL with quotes.

curl -X GET "https://na01ws.apperian.com/v1/applications/23/stats?start_date=2014-01-15&end_date=2014-03-30" --header  "X-TOKEN: yCczCnsNSJyW_3JyS6YwAQ"

Example Response

This example shows a portion of the response.

{
  "app_stats": {
     "download_count": [55],
     "no_auth_download_count": [0],
     "usage_count": [157],
     "mdm_devices": 0
   }
}
GET /v1/applications/(app_psk)/versions/

Attention

There is a newer version of this resource available: GET /v2/applications/<app_id>/versions/. This v1 version will be deprecated in Q3 of 2017. If you currently interface with this v1 resource, please modify your code to point to the latest V2 version. If you have any questions, contact support@apperian.com.

List All Version Information for an Application

Requires user context. Authenticate as a valid EASE user.

Returns version information for all versions of the specified application. Specify the app with app_psk. The app_psk for each app in your organization is included in the data returned by the GET /applications resource.

A new version of an app is stored in EASE whenever a new application file is added to EASE, either when adding a new app or editing an existing app.

The following lists the version information returned in the API response.

psk
Unique identifier created by EASE for the version.
description
Value provided by the administrator when the version was created.
version_num
Value provided by the administrator when the version was created. This value will have defaulted to the version included in the application binary.
release_date
Date when the version was created in EASE.
app_psk
Unique identifier of the app for which the version information is returned.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/versions/
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/versions/

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer

Header Parameters

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/123/versions --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

In this example, there are six versions of the application.

{
     "versions": [
         {
           "psk": 49798,
           "description": "[Applied policies] Latest release",
           "version_num": "2.1",
           "release_date": "2015-07-27T11:33:08.598736+00:00",
           "expires": "2016-09-04T19:14:14+00:00",
           "app_psk": 16776
         },
         {
           "psk": 49627,
           "description": "Bug fixes",
           "version_num": "2.1",
           "release_date": "2015-07-24T18:11:28+00:00",
           "expires": "2016-09-04T19:14:14+00:00",
           "app_psk": 16776
         },
         {
           "psk": 49626,
           "description": "[Applied policies] Latest Release",
           "version_num": "2.0",
           "release_date": "2015-07-24T18:04:23.147802+00:00",
           "expires": "2016-09-04T19:14:14+00:00",
           "app_psk": 16776
         },
         {
           "psk": 47015,
           "description": "Major rework",
           "version_num": "2.0",
           "release_date": "2015-04-10T13:37:46.110738+00:00",
           "expires": "2016-04-06T18:16:50+00:00",
           "app_psk": 16776
         },
         {
           "psk": 39226,
           "description": "[Applied policies] First Release",
           "version_num": "1.0",
           "release_date": "2014-07-08T18:40:00.109543+00:00",
           "expires": "2017-08-14T18:16:50+00:00",
           "app_psk": 16776
         },
         {
           "psk": 38565,
           "description": "First Release",
           "version_num": "1.0",
           "release_date": "2014-06-23T16:29:00.368285+00:00",
           "expires": "2017-08-14T18:16:50+00:00",
           "app_psk": 16776
         }
     ]
}
GET /v1/applications/app_catalogs/

Attention

There is a newer version of this resource available: GET /v2/applications/app_catalogs/. This v1 version will be deprecated in Q3 of 2017. If you currently interface with this v1 resource, please modify your code to point to the latest V2 version. If you have any questions, contact support@apperian.com.

List App Catalog Data

Requires user context. Authenticate as a valid EASE user.

Returns data about all the App Catalogs in the authenticated user’s organization. This resource is similar to the GET /applications/ resource, except that it returns data on App Catalogs only.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/app_catalogs/
Europe https://eu01ws.apperian.eu/v1/applications/app_catalogs/

URL Parameters

None

Header Parameters

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/app_catalogs/ --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

The following example shows the portion of the response that lists data for the HTML5 App Catalog in the user’s organization.

{
  "app_catalogs": [
    {
      "update_compliance_period_in_days": null,
      "url_scheme": "",
      "is_adhoc": false,
      "is_hybrid": false,
      "is_app_catalog": true,
      "required_by": "3099-12-31T00:00:00+00:00",
      "version": {
        "posted_date": "2017-01-24T20:34:04.804846+00:00",
        "app_name": "App Catalog",
        "verification_status": 0,
        "install_file": {
          "file_type_constant": "INSTALLEXE",
          "apperian_wrapper_version": null,
          "veracode_verification_id": null,
          "hash_type": "none",
          "hash_value": null,
          "description": null,
          "kryptowire_verification_id": null,
          "app_psk": 75,
          "size": 8705879,
          "until": "2017-08-09T13:34:52+00:00",
          "psk": 118,
          "complete": true,
          "appthority_verification_id": null,
          "deleted": false,
          "expires": "2017-08-09T13:34:52+00:00",
          "mime": "application/itunes+zip",
          "path": "org_1/iphone_75/version_107/catalog.ipa",
          "name": null,
          "created": "2017-01-24T20:33:57.676041+00:00",
          "version_psk": 107,
          "checksum": "e4659c07db613f970ee7830e3e7e033ea325409d4c574b29516bf4819c5ab50b",
          "sign_credentials_psk": null,
          "action": "upload",
          "binary_metadata": null
        },
        "mdm_id": null,
        "form_factor": 3,
        "wrap_status": 0,
        "signstatus": 0,
        "veracode_verification_status": 0,
        "long_description": "test",
        "author": "test",
        "required_by": "9999-12-31T23:59:59.999999",
        "short_description": "test",
        "app_psk": 75,
        "psk": 107,
        "kryptowire_verification_status": 0,
        "version_note": "test",
        "binary_version": "3",
        "latest_install_file": 118,
        "icon_path": "/icons/applications/htmlAppCatalog.png",
        "custom_metadata": null,
        "files_pruned": false,
        "mdm_status": 0,
        "min_os_version": "6.0",
        "notify_users": false,
        "version_num": "3",
        "release_date": "2017-01-24T20:34:04.804846+00:00",
        "required": false
      },
      "reviews_enabled": true,
      "screenshot_path2": "",
      "screenshot_path3": "",
      "screenshot_path1": "",
      "type": 0,
      "screenshot_path4": "",
      "screenshot_path5": "",
      "status": 1,
      "psk": 75,
      "sort_weight": -30000,
      "no_auth_delivery_enabled": false,
      "deleted": null,
      "is_email_config_profile": false,
      "add_to_start": false,
      "operating_system": 1,
      "bundle_id": "com.apperian.appcatalog.html",
      "banner_image_url": "",
      "tablet_screenshot_path4": "",
      "tablet_screenshot_path5": "",
      "tablet_screenshot_path2": "",
      "tablet_screenshot_path3": "",
      "tablet_screenshot_path1": "",
      "direct_download_binary_url":
          "https://na01ws.apperian.com/v1/downloads/direct/applications/8f92x99Kw8qfHxeDkcK8fA",
      "required": true,
      "latest_version": 107,
      "push_enabled": false,
      "required_by_group": false
    }
  ]
}
GET /v1/applications/user/

Attention

There is a newer version of this resource available: GET /v2/applications/user/. This v1 version will be deprecated in Q3 of 2017. If you currently interface with this v1 resource, please modify your code to point to the latest V2 version. If you have any questions, contact support@apperian.com.

List Applications for a Specific User

Requires user context. Authenticate as a valid EASE user.

Returns data about all the applications available in EASE to the authenticated user. An application is available if it is assigned to a group to which the user belongs.

Mandatory Applications

If an application is mandatory for any groups of which the user is a member, then the value of the required_by_group parameter will be true. If an application is mandatory for all assigned groups, then both the required and required_by_group parameters will be true.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/user/
Europe https://eu01ws.apperian.eu/v1/applications/user/

URL Parameters

None

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/user --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

The following example shows the portion of a response that lists information about the Actions application. The Actions application is not mandatory for all groups to which it is assigned, so the required parameter is set to false. The application is mandatory for one group, however, and the authenticated user is a member of that group. Therefore, the required_by_group parameter is set to true.

Note

The required_by parameter is unrelated to an application’s mandatory setting; required_by identifies the date by which users will be required to install an update of the app if one is available to them (in this case, the date is in the distant future to indicate that an update is optional and not required).

{
  "applications": [
     {
       "operating_system": 1,
       "update_compliance_period_in_days": null,
       "url_scheme": "eas58643,eas58643",
       "form_factor": 3,
       "long_description": "Come on. Get organized today with the Actions app. Keep track of your TO DO list while also monitoring team status, project deadlines, and resource allocation. Organization is the key to success!",
       "is_adhoc": false,
       "platform": null,
       "is_hybrid": false,
       "required_by": "9999-12-31T23:59:59.999999",
       "os_version": null,
       "is_app_catalog": false,
       "version": {
         "verification_status": 0,
         "posted_date": "2016-05-19T18:22:51+00:00",
         "description": "Usability improvements",
         "version_num": "2.0",
         "psk": 173731,
         "latest_install_file": 199303,
         "release_date": "2016-05-19T18:22:51+00:00",
         "required": false,
         "required_by": "9999-12-31T23:59:59.999999",
         "version_num": "2.0",
         "files_pruned": false,
         "app_psk": 58643,
         "wrap_status": 1,
         "signstatus": 1,
         "veracode_verification_status": 0,
         "kryptowire_verification_status": 0,
         "notify_users": true
      },
      "reviews_enabled": true,
      "short_description": "Manage your TO DO list",
      "screenshot_path3": "",
      "screenshot_path1": "",
      "type": 0,
      "screenshot_path4": "",
      "screenshot_path5": "",
      "status": 1,
      "psk": 58643,
      "sort_weight": 1000,
      "no_auth_delivery_enabled": false,
      "deleted": null,
      "icon_path": "org_5741/iphone_58643/Actions_57.png",
      "is_email_config_profile": false,
      "custom_metadata": null,
      "add_to_start": false,
      "screenshot_path2": "",
      "tablet_screenshot_path5": "",
      "min_os_version": "7.1",
      "bundle_id": "com.apperian.Actions",
      "banner_image_url": null,
      "tablet_screenshot_path3": "",
      "tablet_screenshot_path4": "",
      "tablet_screenshot_path2": "",
      "tablet_screenshot_path1": "",
      "required": false,
      "push_enabled": false,
      "required_by_group": true
   },
   ]
}
GET /v1/downloads/direct/applications/(app_psk)/

Download the Application’s Binary File

Authenticate as a user with the Administrator or Developer role. Use session token returned from POST /users/authenticate.

Returns a 302 redirect link to download a native application’s binary file. Use this resource, for example, to download an application that was signed through EASE but needs to be distributed to users through a system other than EASE.

You can download any native application that you manage in EASE, including native apps that were created as hybrid applications.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/downloads/direct/applications/<app_id>
Europe https://eu01ws.apperian.eu/v1/downloads/direct/applications/<app_id>

The URL for this request must include the unique app_id for the app you want to download. This URL, including that app_id, is provided with the direct_download_binary_url field returned by the following resources:

  • GET /applications
  • GET /applications/<app_psk>
  • GET /catalog/categories/<category_psk>/applications
  • GET /catalog/applications/featured
  • GET /catalog/applications/popular
  • GET /catalog/applications/updates

Example:

“direct_download_binary_url”: “https://na01ws.apperian.com/v1/downloads/direct/applications/tauo-ZZD2jY2GppQ

URL Parameters

app_id
(Required) Unique ID provided with the direct_download_binary_url parameter returned for the app by the GET /applications resource. DATA TYPE: string

Header Parameters

X-TOKEN
(Required) Session token returned by POST /users/authenticate.
X-UDID
(Required) Unique identifier assigned by EASE to the device.

Data Parameters

None

Example Requests

The following curl command returns the 302 redirect link.

curl -X GET https://na01ws.apperian.com/v1/downloads/direct/applications/tauo-ZZD2jqXJL1QY2GppQ --header "X-TOKEN: ahHJC6O5STCQyXFAfb-EQ"

Use the -L and --output flags to automatically follow the redirect link and save the output to a file on disk. In the following example, the command saves the file to the filename.ipa file.

curl -L -X GET https://na01ws.apperian.com/v1/downloads/direct/applications/tauo-ZZD2jqXJL1QY2GppQ --header "X-TOKEN: ahHJC6O5STCQyXFAfb-EQ" --output filename.ipa

Example Response

This response shows the 302 redirect link.

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
   <title>Redirecting...</title>
   <h1>Redirecting...</h1>
   <p>You should be redirected automatically to target URL: <a href="https://fdownload.qa.apperian.com/?
   download_token=eGaN0ykNR6WGW4X6PXjqWQ">https://fdownload.qa.apperian.com/?download_token=eGaN0yW4X6PXjqWQ</a>.
 If not click the link.
PUT /v1/applications/(app_psk)/

Update Application (Enable/Disable or Specify Custom Metadata)

Requires administrator privileges. Authenticate as an EASE administrator.

Use this API to enable/disable an application in your organization, or to specify custom metadata about an application. Specify the app with app_psk. The app_psk for each app in your organization is included in the data returned by the GET /applications resource.

Enable or Disable an Application

When the application is enabled-or “published”-it means that users who are members of the groups assigned to that app will have access to it in the App Catalog. You should not enable an app until it is ready for users to install.] For example, do not enable an app that was wrapped but has not yet been re-signed. You may wish to disable an app if you plan to inspect it, apply policies to it, sign it, or send it on an approval process before making it available to users. For more information on the implications of disabling an app in EASE, see Disabled App Behavior.

Specify Custom Metadata for an Application

When you add an application to EASE using the publishing API, you specify standard application metadata, such as name, version, and description. Using this API, you can specify additional custom metadata that is unique and meaningful to your business. For example, say your organization is a university and you manage multiple apps for students and faculty. You can use custom metadata to associate custom metadata for School, Major, Year of Study, Campus, and so on.

Note

You can view an application’s custom metadata in the EASE Portal only if you define a Custom Metadata Template for your organization on the Settings page. For instructions, see Define a Custom Metadata Template. Note that defining a Custom Metadata Template enables you to add/edit/view custom metadata in the EASE Portal, but it is not required to send/receive custom metadata through the API.

Enable or Disable Application Reviews

When you add an application to EASE using the publishing API, whether the Reviews feature is enabled for the app will depend on the default setting for your organization. Using this API, you can override that default to enable/disable Reviews. When the Reviews feature is enabled for an application, your App Catalog users have the option to Like/Dislike (rate) the app, review the app, and browse reviews written by other catalog users. When the Reviews feature is disabled for an application, the Like/Dislike buttons are hidden and the Reviews tab is grayed out.

For more information on the Reviews feature, see App Ratings and Reviews. For instructions on changing the Application Reviews default setting, see Change the Application Reviews Default Setting.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.
Content-Type
(Required) Specifies the content type of the body of data sent with the request. Set to: application/json

Data Parameters

enabled
(Required if enabling/disabling the app) Set to true to enable the application. Set to false to disable the application.
custom_metadata

(Required if sending custom metadata) An array of name-value pairs for the custom metadata field that will be stored in the EASE database. If you are matching a data object defined in a custom metadata template for your organization, be sure to enter the id (not the label) of the JSON data object exactly as it is defined in the template. For example:

"city": "Boston"

Separate each metadata field with a comma and enclose all the metadata fields with brackets. For example:

{"custom_metadata": {"city": "Boston", "firstname": "Diane", "lastname": "Harrelson", "restaurants": "Cheers,Vips"}

reviews_enabled

(Optional) Set to true to enable users to rate (Like/Dislike) and review the application in the App Catalog.

Set to false to prohibit users from rating and review the application in the App Catalog. In the App Catalog, the Like/Dislike buttons will be hidden and the Reviews tab will be grayed out for the application.

Note that you can enable/disable reviews for any application type except Windows Phone apps.

Example Requests and Responses

Disable an Application

The following request disables an application.

curl -X PUT https://na01ws.apperian.com/v1/applications/123 --data '{"enabled": false}' --header "Content-Type: application/json" --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

If the request is successful, whether enabling or disabling the app, the response is true.

{
  "update_application_result": true
}

Specify Custom Metadata

The following request sends four custom metadata fields.

curl -X PUT https://na01ws.apperian.com/v1/applications/123 --data '{"custom_metadata": {"city": "Boston", "firstname": "Diane", "lastname": "Harrelson", "restaurants": "Cheers,Vips"}}' --header "Content-Type: application/json" --header "X-TOKEN: zH2syg3cSmip4EU5Md8a1A"

When the custom metadata is successfully stored in the EASE database, the response indicates true.

{
  "update_application_result": true
}

Disable Application Reviews

The following request disables the Reviews feature for the application. In the App Catalog, the Like/Dislike buttons will be hidden and the Reviews tab will be grayed out for the application.

curl -X PUT https://na01ws.apperian.com/v1/applications/123 --data '{"reviews_enabled": false}' --header "Content-Type: application/json" --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

If the request is successful, whether enabling or disabling the app, the response is true.

{
  "update_application_result": true
}
DELETE /v1/applications/(app_psk)/

Delete Application

Requires user context. Authenticate as a valid EASE user.

Deletes a specific application from your EASE organization so that it is no longer available in any of your users’ App Catalogs or available for any user to download with a Direct Install link.

Specify the app with app_psk. The app_psk for each app in your organization is included in the data returned by the GET /applications resource.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>

URL Parameters

app_psk or appID
(Required) Unique ID assigned by EASE to the app. You can provide either the app_psk or appID. DATA TYPE: integer

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X DELETE https://na01ws.apperian.com/v1/applications/22735 --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

This response indicates that the application was successfully deleted.

{
  "deleted_application": 22735
}

This response indicates that the application could not be deleted because the authenticated user does not have access to the specified app_psk.

{
  "error": {
    "code": 11,
    "message": "User is not allowed to access resource id 2735",
    "guid": "75789468-c488-4bae-864f-0eb29f9079de",
    "error_details": null
  }
}
POST /v1/applications/(app_psk)/icon/

Upload an Icon for An Application

Requires administrator privileges. Authenticate as an EASE administrator.

Use this resource to upload an application icon that will display for the application in both the App Catalog and the Applications page in the EASE Portal. This icon can be different than the icon bundled with the application binary. For example, you can upload an icon with a “NEW” or “IMPROVED” sticker to draw your users’ attention to a particular app in the catalog. Note that regardless of the icon uploaded to EASE, the icon bundled with the application binary is what will display on the device when the app is installed.

Send the API request as a multipart form that contains a single file. EASE supports PNG (.png) and JPEG (.jpg but not .jpeg) file formats. The image should be a minimum of 114 x 114 pixels.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/icon/
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/icon/

URL Parameters

app_psk
(Required) Unique ID for the app. DATA TYPE: integer

Header Parameters

X-TOKEN
(Required) Session token returned by POST /users/authenticate.
Content-Type
(Required) Specifies the content type of the body of data sent with the request. Set to: application/json

Form Parameters

icon
(Required) Specifies the icon file. The file must be in PNG (.png) or JPEG (.jpg) format and the file name cannot exceed 120 characters.

The dimensions of the file will not be validated with the request, but the image should be at least 114 x 114 pixels for optimal performance.

Data Parameters

None

Example Request

Use the -i (include) argument if you want to return the HTTP header in the output so that you can see the HTTP status message. Without -i, a successful request returns a blank response.

curl -i https://ws-qaease.qa.apperian.com/applications/16776/icon -F icon=@newapp.png --header "X-Token:wBZ99s1fQpyK7tZ0bYAHdA"

Example Response

This is an example of a response to a curl command with the -i argument. The HTTP 201 message indicates that the file was successfully uploaded.

HTTP/1.1 100 Continue

HTTP/1.1 201 CREATED
Date: Tue, 09 Feb 2016 18:37:05 GMT
Server: Apache
Content-Length: 0
Access-Control-Allow-Origin: null
Vary: Accept-Encoding
Connection: close
Content-Type: text/html; charset=utf-8
POST /v1/applications/(app_psk)/banner_image

Add or Update Banner Image for an Application

Requires administrator privileges. Authenticate as an EASE administrator.

You can associate a banner image with an application and then display that image in your custom App Catalog (a catalog built using the Catalog API). Note that you cannot display application banner images if you are using a standard branded catalog.

Use this API resource to add or update the banner image for a specific application. Specify the app with its app_psk or appID. The app_psk for each app in your organization is included in the data returned by the GET /applications resource. The appID is returned by the publishing API.

An application can have only one banner image associated with it; if you upload an image for an app that already has a banner image, EASE will update that image.

The URL of an application’s banner image is returned in the banner_image_url parameter when you send a GET request to Applications API or Catalog API resources:

"banner_image_url": "/org_15/iphone_125/myappbanner.jpg"

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/banner_image
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/banner_image

URL Parameters

app_psk or appID
(Required) Unique ID assigned by EASE to the app. You can provide either the app_psk or appID. DATA TYPE: integer

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Form Parameters

banner_image
(Required) Specifies the banner image file. The file must be in PNG (.png) or JPEG (.jpg or .jpeg) format. There are no required dimensions or resolution requirements, but you should consider the design of your custom App Catalog and where the image will be displayed.

Example Request

curl -X POST https://na01ws.apperian.com/v1/applications/22735/banner_image --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"
-F "banner_image=@/root/src/image.jpg"

Example Response

This response indicates that the banner image was successfully added or updated for the application.

{
  "banner_image_path": /uploads/org_11/iphone_85/image.jpg
}

This response indicates that the banner image for the application could not be added because the specified app_psk is not in the authenticated user’s organization.

{
  "error": {
    "code": 11,
    "message": "User is not allowed to access resource id 12011",
    "guid": "ca35efb3-c7a8-40b4-8915-1e68fca446ba",
    "error_details": null
   }
}
DELETE /v1/applications/(app_psk)/banner_image

Delete Banner Image for an Application

Requires administrator privileges. Authenticate as an EASE administrator.

Use this API resource to delete the banner image for a specific application. Specify the app with its app_psk or appID. The app_psk for each app in your organization is included in the data returned by the GET /applications resource. The appID is returned by the publishing API.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/banner_image
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/banner_image

URL Parameters

app_psk or appID
(Required) Unique ID assigned by EASE to the app. You can provide either the app_psk or appID. DATA TYPE: integer

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Form Parameters

None

Example Request

curl -X DELETE https://na01ws.apperian.com/v1/applications/22735/banner_image --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

This response indicates that the banner image was successfully deleted. A response of false indicates that the application does not have an associated banner image so there was nothing to delete.

{
  "deleted_banner_image": true
}

This response indicates that the banner image for the application could not be deleted because the specified app_psk is not in the authenticated user’s organization.

{
  "error": {
    "code": 11,
    "message": "User is not allowed to access resource id 12011",
    "guid": "ca35efb3-c7a8-40b4-8915-1e68fca446ba",
    "error_details": null
   }
}
GET /v2/applications/user/

List Applications for a Specific User

Requires user context. Authenticate as a valid EASE user.

Returns data about all the applications available in EASE to the authenticated user. An application is available if it is assigned to a group to which the user belongs.

Mandatory Applications

If an application is mandatory for any groups of which the user is a member, then the value of the required_by_group parameter will be true. If an application is mandatory for all assigned groups, then both the required and required_by_group parameters will be true.

URLs

Environment URL
North America https://na01ws.apperian.com/v2/applications/user/
Europe https://eu01ws.apperian.eu/v2/applications/user/

URL Parameters

None

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v2/applications/user --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

The following example shows the portion of a response that lists information about the Actions application. The Actions application is not mandatory for all groups to which it is assigned, so the required parameter is set to false. The application is mandatory for one group, however, and the authenticated user is a member of that group. Therefore, the required_by_group parameter is set to true.

NOTE: The required_by parameter is unrelated to an application’s mandatory setting; required_by identifies the date by which users will be required to install an update of the app if one is available to them (in this case, the date is in the distant future to indicate that an update is optional and not required).

{
    "applications": [
        {
            "add_to_start": false,
            "banner_image_url": "",
            "bundle_id": "com.apperian.demo.actions",
            "id": "MCYv1NLWlStmdT3DIsZX-Q",
            "is_adhoc": false,
            "is_app_catalog": false,
            "is_email_config_profile": false,
            "is_hybrid": false,
            "latest_version": 17505,
            "latest_version_id": "M9Kr-th6C1B3t8NTNJVsoA",
            "no_auth_delivery_enabled": false,
            "operating_system": 103,
            "psk": 6766,
            "push_enabled": false,
            "required": false,
            "required_by": "3099-12-31T00:00:00+00:00",
            "required_by_group": true,
            "reviews_enabled": true,
            "sort_weight": 1000,
            "status": 1,
            "type": 3,
            "update_compliance_period_in_days": null,
            "url_scheme": "",
            "version": {
                "app_id": "MCYv1NLWlStmdT3DIsZX-Q",
                "app_name": "Actions",
                "app_psk": 6766,
                "author": "Example Company",
                "binary_version": "1.0",
                "custom_metadata": null,
                "form_factor": 2,
                "icon_path": "org_45/android_6766/appicon.png",
                "id": "M9Kr-th6C1B3t8NTNJVsoA",
                "kryptowire_verification_status": 0,
                "latest_install_file": 21505,
                "latest_install_file_id": "VxvMyQ__IhFgVGpX_7gA5w",
                "long_description": "Get organized today with the Actions app!",
                "min_os_version": "11",
                "notify_users": true,
                "psk": 17505,
                "release_date": "2016-12-08T22:56:21+00:00",
                "required": false,
                "required_by": "9999-12-31T23:59:59.999999",
                "short_description": "Manage your TO DO list",
                "sign_status": 1,
                "version_note": "latest",
                "version_num": "1.0",
                "wrap_status": 0,
                "install_file": {
                   "psk": 1061,
                   "created": "2017-09-15T18:01:58.842322+00:00",
                   "kryptowire_verification_id": null,
                   "apperian_wrapper_version": null,
                   "sign_credentials_id": null,
                   "version_psk": 433,
                   "checksum": "82fe2fe4529434dbbe4dbacf70e896ce5ae29d74caea75535d53a67610cc884e",
                   "expires": "9999-12-31T23:59:59.999999+00:00",
                   "app_id": "a0D0xt0bgfXUt1cLA6Z0qA",
                   "version_id": "IY0bzB2-6o-hgaj17FtQxg",
                   "sign_credentials_psk": null,
                   "mime": "application/vnd.android.package-archive",
                   "binary_metadata": {
                       "warning_keys": [],
                       "errors": [],
                       "warnings": [],
                       "metadata": {
                           "is_cordova": false,
                           "manifest": {
                               "sdkVersion": "11",
                               "densities": [
                                   "120",
                                   "160",
                                   "240"
                               ],
                               "package": {
                                   "versionCode": "1",
                                   "name": "com.apperian.demo.actions",
                                   "versionName": "1.0"
                               },
                               "application": {
                                   "label": "Actions",
                                   "icon": "res/drawable-hdpi/appicon.png"
                               },
                               "supports-any-density": true,
                               "uses-feature": [
                                   "android.hardware.wifi",
                                   "android.hardware.touchscreen"
                               ],
                               "uses-permission": [
                                   "android.permission.INTERNET",
                                   "android.permission.ACCESS_WIFI_STATE"
                               ],
                               "locales": [
                                   "--_--"
                               ]
                           }
                       }
                   },
                   "path": "org_14/android_191/version_433/Actions.apk",
                   "action": "upload",
                   "app_psk": 191,
                   "id": "7JQlAmx32e3LjFzKXr5yqg",
                   "size": 159054
               }
            }
        }
    ]
}
GET /v2/applications/

List All Applications

Requires user context. Authenticate as a valid EASE user.

Returns data about all the native applications stored in the EASE database for the authenticated user’s organization. To identify whether an application is enabled, look at the value of the status parameter in the response: 0 indicates disabled; 1 indicates enabled.

Note

For each application, the response includes a direct_download_binary_url field. Send a GET request to the URL provided in that field to download the app’s binary file. For more information, see GET /downloads/direct/applications/<app_id>.

URLs

Environment URL
North America https://na01ws.apperian.com/v2/applications/
Europe https://eu01ws.apperian.eu/v2/applications/

URL Parameters

When you send a GET request to this resource, you can specify URL parameters to search, sort, and paginate the JSON data returned in the response. For more information, see Controlling GET Responses.

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v2/applications/ --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

This example shows a portion of the response. With the status parameter, 0 indicates disabled; 1 indicates enabled.

{
  "applications": [
    {
      "operating_system": 1,
      "update_compliance_period_in_days": null,
      "url_scheme": "",
      "is_adhoc": false,
      "is_hybrid": false,
      "required_by": "3099-12-31T00:00:00+00:00",
      "is_app_catalog": false,
      "latest_version_id": "Qll-img_ThVgPUS9hRS4Yw",
      "version": {
        "id": "Qll-img_ThVgPUS9hRS4Yw",
        "version_note": "This is the newest version!",
        "version_num": "2.0",
        "form_factor": 3,
        "long_description": "Come on. Get organized! Use this app to manage your TO DO list, and to sync up with project team members.",
                   "latest_install_file_id": "Qll-img_ThVgPUS9hRS4Yw",
        "release_date": "2016-03-22T13:42:03.678841+00:00",
        "required": false,
        "required_by": "9999-12-31T23:59:59.999999",
        "icon_path": "org_11/iphone_75/Actions_57.png",
        "app_id": "Qll-img_ThVgPUS9hRS4Yw",
        "wrap_status": 2,
        "custom_metadata": null,
        "min_os_version": "7.1",
        "sign_status": 0,
        "short_description": "Manage your TO DO list",
        "kryptowire_verification_status": 0,
        "notify_users": false,
        "app_name": "Actions",
        "install_file": {
          "apperian_wrapper_version": 17,
          "kryptowire_verification_id": null,
          "app_id": "Qll-img_ThVgPUS9hRS4Yw",
          "size": 965423,
          "id": "Qll-img_ThVgPUS9hRS4Yw",
          "expires": null,
          "mime": "application/itunes+zip",
          "path": "org_2/android_4/Actions.apk",
          "created": "2016-03-22T14:04:12.120484+00:00",
          "version_id": "Qll-img_ThVgPUS9hRS4Yw",
          "checksum": null,
          "sign_credentials_id": null,
          "action": "wrap",
          "binary_metadata": null
        }
      },
      "reviews_enabled": true,
      "type": 0,
      "status": 0,
      "id": "Qll-img_ThVgPUS9hRS4Yw",
      "sort_weight": 1000,
      "no_auth_delivery_enabled": true,
      "is_email_config_profile": false,
      "add_to_start": false,
      "bundle_id": "com.apperian.Actions",
      "banner_image_url": null,
      "categories": [
        {
          "constant": "COMPANY",
          "name": "Company Wide",
          "icon_path": "/icons/categories/company_wide.png",
          "description": "",
          "id": "XTBEV_SGPlI0oI8ozGTh0A",
          "org_id": "Ynm4meEuG4HOIOu7zwtC3A"
        }
      ],
      "direct_download_binary_url":
            "https://na01ws.apperian.com/v1/downloads/direct/applications/8f92x99Kw8qfHxeDkcK8fA",
      "required": false,
      "push_enabled": false
    },
    {
      "operating_system": 102,
      "update_compliance_period_in_days": null,
      "url_scheme": "",
      "is_adhoc": false,
      "is_hybrid": false,
      "required_by": "9999-12-31T23:59:59.999999",
      "is_app_catalog": false,
      "version": {
        "id": "Qll-img_ThVgPUS9hRS4Yw",
        "description": "The latest version",
        "version_num": "1.0",
        "form_factor": 3,
        "long_description": "Access all things related to Example Company benefits.",
        "latest_install_file_id": "Qll-img_ThVgPUS9hRS4Yw",
        "release_date": "2016-03-22T15:24:13.668336+00:00",
        "short_description": "Example Company Benefits",
        "required": false,
        "required_by": "9999-12-31T23:59:59.999999",
        "app_id": "Qll-img_ThVgPUS9hRS4Yw",
        "wrap_status": 1,
        "custom_metadata": null,
        "icon_path": "org_11/android_76/appicon.png",
        "sign_status": 0,
        "min_os_version": "3",
        "kryptowire_verification_status": 0,
        "notify_users": true,
        "app_name": "Benefits",
        "install_file": {
          "apperian_wrapper_version": 20,
          "kryptowire_verification_id": null,
          "app_id": "Qll-img_ThVgPUS9hRS4Yw",
          "size": 2649824,
          "id": "Qll-img_ThVgPUS9hRS4Yw",
          "expires": null,
          "mime": "application/vnd.android.package-archive",
          "created": "2016-03-22T18:14:16.418391+00:00",
          "version_id": "Qll-img_ThVgPUS9hRS4Yw",
          "checksum": "e16f266dcdbf600acd53f7a2bf55babe1d36c896a7c8e4c687a2d012bf6dd297",
          "sign_credentials_id": null,
          "action": "sign_with_package",
          "binary_metadata": null
        }
      },
      "reviews_enabled": true,
      "type": 3,
      "status": 0,
      "id": "Qll-img_ThVgPUS9hRS4Yw",
      "sort_weight": 1000,
      "no_auth_delivery_enabled": true,
      "is_email_config_profile": false,
      "add_to_start": false,
      "bundle_id": "com.example.benefits",
      "banner_image_url": null,
      "categories": [
        {
          "constant": "COMPANY",
          "name": "Company Wide",
          "icon_path": "/icons/categories/company_wide.png",
          "description": ""
          "id": "XTBEV_SGPlI0oI8ozGTh0A",
          "org_id": "Ynm4meEuG4HOIOu7zwtC3A"
        }
      ],
      "direct_download_binary_url":
            "https://na01ws.apperian.com/v1/downloads/direct/applications/6fCatAVv29awTRDAudfL0A",
      "required": false,
      "push_enabled": false
    }
  ],
  "total_available": 2
}
GET /v2/applications/app_catalogs/

List App Catalog Data

Requires user context. Authenticate as a valid EASE user.

Returns data about all the App Catalogs in the authenticated user’s organization. This resource is similar to the GET /applications/ resource, except that it returns data on App Catalogs only.

URLs

Environment URL
North America https://na01ws.apperian.com/v2/applications/app_catalogs/
Europe https://eu01ws.apperian.eu/v2/applications/app_catalogs/

URL Parameters

None

Header Parameters

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v2/applications/app_catalogs/ --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

The following example shows the portion of the response that lists data for the iOS App Catalog in the user’s organization.

{
    "app_catalogs": [
        {
            "add_to_start": false,
            "banner_image_url": "",
            "bundle_id": "com.apperian.appcatalog",
            "direct_download_binary_url": "https://ws-qa3ease.qa.apperian.com/v1/downloads/direct/applications/AN2TTLCbhdHl_M1aNJ4ltQ",
            "id": "AN2TTLCbhdHl_M1aNJ4ltQ",
            "is_adhoc": false,
            "is_app_catalog": true,
            "is_email_config_profile": false,
            "is_hybrid": false,
            "latest_version": 17632,
            "latest_version_id": "KJfUfgCwzUfeF9iwd2zl3w",
            "no_auth_delivery_enabled": false,
            "operating_system": 1,
            "psk": 6852,
            "push_enabled": false,
            "required": false,
            "required_by": "9999-12-31T23:59:59.999999",
            "required_by_group": false,
            "reviews_enabled": true,
            "sort_weight": -30000,
            "status": 1,
            "type": 0,
            "update_compliance_period_in_days": null,
            "url_scheme": "appcatalog",
            "version": {
                "app_id": "AN2TTLCbhdHl_M1aNJ4ltQ",
                "app_name": "App Catalog",
                "app_psk": 6852,
                "author": "Example Company",
                "binary_version": "3.0.504",
                "custom_metadata": null,
                },
                "form_factor": 3,
                "icon_path": "org_45/iphone_6852/AppIcon76x76@2x~ipad.png",
                "id": "KJfUfgCwzUfeF9iwd2zl3w",
                "install_file": {
                    "action": "sign",
                    "app_id": "AN2TTLCbhdHl_M1aNJ4ltQ",
                    "app_psk": 6852,
                    "apperian_wrapper_version": null,
                    "checksum": "debc12ad7c0861422e8c2a1d0d305902061878aa8029a92ebe6b8a758bbe0a29",
                    "created": "2017-01-30T21:43:56+00:00",
                    "expires": "2017-09-03T19:04:52+00:00",
                    "id": "GuW2ysq4B9qLa5UK2CsSdA",
                    "kryptowire_verification_id": null,
                    "mime": "application/itunes+zip",
                    "path": "org_2/android_5/AppCatalog3QA.apk",
                    "psk": 21797,
                    "sign_credentials_id": "uPSpAolBHnylXEx8HIhnPA",
                    "sign_credentials_psk": 444,
                    "size": 10666103,
                    "version_id": "KJfUfgCwzUfeF9iwd2zl3w",
                    "version_psk": 17632,
                    "binary_metadata": null
                },
                "kryptowire_verification_status": 0,
                "latest_install_file": 21797,
                "latest_install_file_id": "GuW2ysq4B9qLa5UK2CsSdA",
                "long_description": "app cat",
                "min_os_version": "6.0",
                "notify_users": true,
                "psk": 17632,
                "release_date": "2017-01-30T21:43:56+00:00",
                "required": false,
                "required_by": "9999-12-31T23:59:59.999999",
                "short_description": "iOS App Catalog",
                "sign_status": 1,
                "version_note": "latest",
                "version_num": "3.0.504",
                "wrap_status": 0
             }
        }
GET /v2/applications/(app_id)/versions/

List Version Information for an Application

Requires user context. Authenticate as a valid EASE user.

Returns information about all versions of the specified application. Specify the app with app_id. The app_id for each app in your organization is included in the data returned by the GET /applications resource.

A new version of an app is stored in EASE whenever a new application file is added to EASE, either when adding a new app or editing an existing app.

The following lists the version information returned in the API response.

id
Unique identifier created by EASE for the version.
version_note
Version note provided by the administrator when the version was created.
version_num
Version number provided by the administrator when the version was created. This value will have defaulted to the version included in the application binary.
release_date
Date when the version was created in EASE.
expires
Date when the application expires.
app_id
Unique identifier of the app for which the version information is returned.

URLs

Environment URL
North America https://na01ws.apperian.com/v2/applications/<app_id>/versions/
Europe https://eu01ws.apperian.eu/v2/applications/<app_id>/versions/

URL Parameters

app_id
(Required) Unique ID for the app. DATA TYPE: integer

Header Parameters

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v2/applications/HtiJL5SOblmu9NMVhN8NXA/versions --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

In this example, there are three versions of the application.

{
   "versions": [
       {
           "app_id": "HtiJL5SOblmu9NMVhN8NXA",
           "app_psk": 6119,
           "expires": "2017-07-26T12:52:15+00:00",
           "id": "o3KEKEizIoJIhap0t9UoWA",
           "psk": 17640,
           "release_date": "2017-02-02T21:00:24.143208+00:00",
           "version_note": "Latest production release",
           "version_num": "3.0",
           "custom_metadata": {
                  "city": "Boston",
                  "name": "Diane",
                  "lastname": "Harrelson",
                  "restaurants": "Cheers"
            }
       },
       {
           "app_id": "HtiJL5SOblmu9NMVhN8NXA",
           "app_psk": 6119,
           "expires": "2017-07-26T12:52:15+00:00",
           "id": "uu8JNzWeMqsiMJunptZH_A",
           "psk": 16856,
           "release_date": "2016-08-16T21:30:35+00:00",
           "version_note": "Fixes UI bugs",
           "version_num": "2.0",
           "custom_metadata": null
       },
       {
           "app_id": "HtiJL5SOblmu9NMVhN8NXA",
           "app_psk": 6119,
           "expires": "2016-08-20T00:48:06+00:00",
           "id": "oRfVDizQVUrEGp_8lZpTPA",
           "psk": 16574,
           "release_date": "2016-08-16T21:26:00+00:00",
           "version_note": "First versions",
           "version_num": "1.0",
           "custom_metadata": null
       }
   ]
}
GET /v2/applications/(app_id)

List Data for a Specific Application

Requires user context. Authenticate as a valid EASE user.

Returns data about the specified application. Specify the app with app_id. The app_id for each app in your organization is included as the id parameter in the data returned by the GET /applications resource.

The response lists many details about the application, including its:

Direct Download URL: Send a GET request to the URL provided in the direct_download_binary_url field to download the app’s binary.

Signing Status: After you send a PUT request to /applications/<app_id>/credentials/<credentials_psk>, use the following fields to monitor signing status:

Field Description
signing_status

The current status of the signing process. Valid values include:

  • in_progress
  • signed
  • cancelled
  • error

Note that a sign_status field is also returned, but can be ignored. It returns a number value for one of the statuses above.

signing_status_details

Additional information about the signing status. This field is useful primarily when the signing status is error. For example:

The cert or profile is expired and will not run on any device.

See the Example Response below to view all the data returned about each app. To identify whether an application is enabled, look at the value of the status parameter: 0 indicates disabled; 1 indicates enabled.

URLs

Environment URL
North America https://na01ws.apperian.com/v2/applications/<int:app_id>
Europe https://eu01ws.apperian.eu/v2/applications/<int:app_id>

URL Parameters

app_id
(Required) Unique ID of the app. DATA TYPE: integer

Header Parameters

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None.

Example Request

curl -X GET https://na01ws.apperian.com/v2/applications/Da7X7EENA0D82j5vA9T5KQ --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

Note that the following response includes custom metadata that was specified for the app using the PUT /applications/<app_psk> API. The status parameter has a value of 0, which indicates that the app is disabled.

{
      "application": {
        "operating_system": 1,
        "update_compliance_period_in_days": null,
        "url_scheme": "",
        "is_adhoc": false,
        "is_hybrid": false,
        "required_by": "3099-12-31T00:00:00+00:00",
        "is_app_catalog": false,
        "latest_version_id": "g-zL5G6YkxZOrbJHd0j9zA",
        "version": {
          "id": "akqL5G2YkxZOrbJHd0j9zB",
          "form_factor": 3,
          "long_description": "Come on. Get organized! Use this app to manage your TO DO list, and to sync up with project team members.",
          "custom_metadata": {
              "city": "Boston",
              "name": "Diane",
              "lastname": "Harrelson",
              "restaurants": "Cheers"
          },
          "icon_path": "org_11/iphone_75/Actions_57.png",
          "short_description": "Manage your To DO list.",
          "min_os_version": "7.1",
          "version_note": "Latest version",
          "version_num": "2.0",
          "latest_install_file_id": "3FQNPpmrGTjviMiJ5vNOxA",
          "release_date": "2016-03-22T13:42:03.678841+00:00",
          "required": false,
          "notify_users": false,
          "required_by": "9999-12-31T23:59:59.999999",
          "signing_status_details": "The application was signed successfully.",
          "signing_status": "signed",
          "app_id": "Skhyo45wxzMEiZVlgBkaZw",
          "app_name": "Training",
          "sign_status": 0,
          "kryptowire_verification_status": 0,
          "wrap_status": 2,
          "install_file": {
            "apperian_wrapper_version": 17,
            "kryptowire_verification_id": null,
            "app_id": "Skhyo45wxzMEiZVlgBkaZw",
            "size": 965423,
            "id": "3FQNPpmrGTjviMiJ5vNOxA",
            "expires": null,
            "mime": "application/itunes+zip",
            "path": "org_2/iphone_43/Training.ipa",
            "created": "2016-03-22T14:04:12.120484+00:00",
            "version_id": "g-zL5G6YkxZOrbJHd0j9zA",
            "checksum": null,
            "sign_credentials_id": null,
            "action": "wrap",
            "binary_metadata": null
          }
        },
        "reviews_enabled": true,
        "type": 0,
        "status": 0,
        "id": "Da7X7EENA0D82j5vA9T5KQ",
        "sort_weight": 1000,
        "no_auth_delivery_enabled": true,
        "is_email_config_profile": false,
        "add_to_start": false,
        "bundle_id": "com.apperian.Actions",
        "banner_image_url": null,
        "direct_download_binary_url":
            "https://na01ws.apperian.com/v1/downloads/direct/applications/8f92x99Kw8qfHxeDkcK8fA",
        "required": false,
        "push_enabled": false
      }
    }

For a list of messages that may be returned in the signing_status_details field, see Signing Status Messages.

GET /v1/applications/(app_psk)/screenshots/

List Screenshots for an Application

Requires user context. Authenticate as a valid EASE user.

Returns the list of screenshots for the specified application. Specify the app with app_psk. The app_psk for each app in your organization is included in the data returned by the GET /applications resource.

URLs

Environment URL
North America https://na01ws.apperian.com/v1/applications/<app_psk>/screenshots/
Europe https://eu01ws.apperian.eu/v1/applications/<app_psk>/screenshots/

URL Parameters

app_psk
(Required) Unique ID assigned by EASE to the app. DATA TYPE: integer

Header Parameter

X-TOKEN
(Required) Session token returned by POST /users/authenticate.

Data Parameters

None

Example Request

curl -X GET https://na01ws.apperian.com/v1/applications/123/screenshots/ --header "X-TOKEN: eTg8ktZXRqKIBJTHunwP6A"

Example Response

In this example, there are three regular screenshots and two tablet screenshots associated with the specified application.

{
     "screenshot_paths": {
       "phone": [
         "org_11/iphone_79/action-item.png",
         "org_11/iphone_79/splash-2.png",
         "org_11/iphone_79/menu-phone.png"
       ],
       "tablet": [
         "org_11/iphone_79/__tablet007__menu-tablet.PNG",
         "org_11/iphone_79/__tablet007__action-item-tablet.PNG"
       ]
     }
}