Application

Summary

API Manager application.

Description

API Manager application information. Application objects support custom properties.

Fields

Field Name Type Since Version Description
apiMgmtInstalled Boolean none
id String The unique identifier for the application
name String The display name for the application
description String Descriptive text for the application
organizationId String The organization identifier to which the application belongs
phone String Contact phone number of the application
email String The contact email address associated with the application
createdBy String The unique identifier for user that created the application
managedBy [String] A list of unique identifier for users that manages the application
createdOn Long Epoch/Unix time stamp when the application was created
enabled Boolean Flag to indicate if this application is enabled or not
image String URI of the image to be used for this application, this field only indicates that the application has an image assigned to it. In order to retrieve the actual image use the following URL /api/portal/applications/{id}/image/
state String Flag to indicate if an application has been approved by the API Manager admin or if delegated then the org admin

Example JSON

{
  "id" : "b76a3e23-deca-49ab-9682-79cd503b7e3a",
  "name" : "My First iPhone App",
  "description" : "My First iPhone App which is a \"Hello World\" basic application",
  "organizationId" : "3e21b76a-defa-49ab-9682-a9cd60387e37",
  "phone" : "+1 877-564-7700",
  "email" : "support@acmecorp.com",
  "createdBy" : "de077cd8-83b7-46d1-b06f-2eaaf1548898",
  "managedBy" : [ "de077cd8-83b7-46d1-b06f-2eaaf1548898" ],
  "createdOn" : 1364407145121,
  "enabled" : false,
  "image" : "resources/photo.jpg",
  "state" : "approved"
}