applications resource

Resource for working with applications and components.

JSON request templates

Some commands in this resource generate JSON output in multiple formats, as specified by the format parameter. These output formats include different subsets of properties for the requested elements, as appropriate for different use cases. The included properties for each format are described in the JSON templates below.

TEMPLATE_ROOT

{
  "automated": "'true' if the application is managed by an 
  integration provider or 'false' if it was created 
  manually",
  "createdByUserId": "ID of the user that created the 
  application",
  "dateCreated": "Timestamp that represents the date when 
  the application was created.",
  "description": "Application description",
  "ghostedDate": "Timestamp that represents the date when 
  the application has been deleted. If greater than 0, the 
  application has been removed.",
  "id": "Application ID",
  "level": "Application level: COMPONENT, APPLICATION, 
  SUITE",
  "name": "Application name",
  "version": "Hibernate version number"
}

list

{
  "automated": "'true' if the application is managed by an 
  integration provider or 'false' if it was created 
  manually",
  "children": "[Array of application components (See: 
  application TEMPLATE_LIST)]",
  "createdByUserId": "ID of the user that created the 
  application",
  "dateCreated": "Timestamp that represents the date when 
  the application was created.",
  "description": "Application description",
  "ghostedDate": "Timestamp that represents the date when 
  the application has been deleted. If greater than 0, the 
  application has been removed.",
  "id": "Application ID",
  "level": "Application level: COMPONENT, APPLICATION, 
  SUITE",
  "name": "Application name",
  "releaseEnvironments": "[Array of release environment 
  IDs]",
  "teams": "[Array of teams  See: team TEMPLATE_NAME]",
  "version": "Hibernate version number"
}

detail

{
  "automated": "'true' if the application is managed by an 
  integration provider or 'false' if it was created 
  manually",
  "children": "[Array of application components (See: 
  application TEMPLATE_LIST)]",
  "createdByUserId": "ID of the user that created the 
  application",
  "dateCreated": "Timestamp that represents the date when 
  the application was created.",
  "description": "Application description",
  "ghostedDate": "Timestamp that represents the date when 
  the application has been deleted. If greater than 0, the 
  application has been removed.",
  "id": "Application ID",
  "integrationProvider": {
    "currentState": "If the Integration is running or not. 
  (Running or Finished)",
    "dateCreated": "Timestamp that represents the date 
  when the Integration Provider has been created.",
    "frequency": "Frequency in minutes that the 
  Integration Provider will be run at, 0 means the 
  Integration Provider will be run manually only.",
    "ghostedDate": "Timestamp that represents the date 
  when the Integration Provider has been deleted. If greater 
  than 0 the Integration Provider has been removed.",
    "id": "Integration Provider ID",
    "lastExecutionStatus": "Status of the last execution 
  of the Integration. (Failed or Success)",
    "name": "Integration Provider Name",
    "version": "Version number"
  },
  "level": "Application level: COMPONENT, APPLICATION, 
  SUITE",
  "name": "Application name",
  "releaseEnvironments": "[Array of Release Environment 
  ids]",
  "targets": {
    "dateCreated": "Timestamp that represents the date 
  when the Application Target has been created.",
    "ghostedDate": "Timestamp that represents the date 
  when the Application Target has been deleted. If greater 
  than 0 the Application Target has been removed.",
    "id": "Application Target ID",
    "name": "Application Target Name",
    "version": "Version number"
  },
  "tasks": {
    "automated": "Will be true if the Task has been 
  imported from an Integration Provider (true or false)",
    "dateCreated": "Timestamp that represents the date 
  when the Task has been created.",
    "duration": "Estimated duration in minute",
    "ghostedDate": "Timestamp that represents the date 
  when the Task has been deleted. If greater than 0 the Task 
  has been removed.",
    "id": "Task ID",
    "name": "Task Name",
    "onlyChangedVersions": "Weither the Task will use only 
  changed versions or not",
    "propSheet": {"id": "propSheet ID"},
    "targetMatch": "If the Task will be executed on 
  Application Target depending on their Tags (ALL_TARGETS, 
  WITH_ALL_OF_TAGS, WITH_ANY_OF_TAGS)",
    "taskPattern": "If the Task will be executed every 
  time or just once per environment (ALWAYS, 
  ONCE_PER_ENVIRONMENT)",
    "version": "Version number"
  },
  "teams": "[Array of Teams  See: team TEMPLATE_NAME]",
  "version": "Hibernate version number"
}

externalIntegrationDetails

{
  "automated": "'true' if the application is managed by an 
  integration provider or 'false' if it was created 
  manually",
  "createdByUserId": "ID of the user that created the 
  application",
  "dateCreated": "Timestamp that represents the date when 
  the application was created.",
  "description": "Application description",
  "ghostedDate": "Timestamp that represents the date when 
  the application has been deleted. If greater than 0, the 
  application has been removed.",
  "id": "Application ID",
  "integrationPropSheet": "Properties that are related to 
  the integration",
  "integrationProvider": {
    "currentState": "If the Integration is running or not. 
  (Running or Finished)",
    "dateCreated": "Timestamp that represents the date 
  when the Integration Provider has been created.",
    "frequency": "Frequency in minutes that the 
  Integration Provider will be run at, 0 means the 
  Integration Provider will be run manually only.",
    "ghostedDate": "Timestamp that represents the date 
  when the Integration Provider has been deleted. If greater 
  than 0 the Integration Provider has been removed.",
    "id": "Integration Provider ID",
    "lastExecutionStatus": "Status of the last execution 
  of the Integration. (Failed or Success)",
    "name": "Integration Provider Name",
    "version": "Version number"
  },
  "level": "Application level: COMPONENT, APPLICATION, 
  SUITE",
  "name": "Application name",
  "version": "Hibernate version number"
}

TEMPLATE_CHANGE

{
  "automated": "'true' if the application is managed by an 
  integration provider or 'false' if it was created 
  manually",
  "children": "[Array of application components (See: 
  application TEMPLATE_ROOT)]",
  "createdByUserId": "ID of the user that created the 
  application",
  "dateCreated": "Timestamp that represents the date when 
  the application was created.",
  "description": "Application description",
  "ghostedDate": "Timestamp that represents the date when 
  the application has been deleted. If greater than 0, the 
  application has been removed.",
  "id": "Application ID",
  "level": "Application level: COMPONENT, APPLICATION, 
  SUITE",
  "name": "Application name",
  "totalChanges": {
    "Accepted": {
      "Change type ID": {
        "count": "Number of changes of that type for the 
  specified status",
        "icon": "Change type icon",
        "id": "Change type ID",
        "name": "Change type name"
      },
      "total": {"count": "Total number of changes for the 
  specified status"}
    },
    "Completed": {
      "Change type ID": {
        "count": "Number of changes of that type for the 
  specified status",
        "icon": "Change type icon",
        "id": "Change type ID",
        "name": "Change type name"
      },
      "total": {"count": "Total number of changes for the 
  specified status"}
    },
    "In Progress": {
      "Change type ID": {
        "count": "Number of changes of that type for the 
  specified status",
        "icon": "Change type icon",
        "id": "Change type ID",
        "name": "Change type name"
      },
      "total": {"count": "Total number of changes for the 
  specified status"}
    },
    "New": {
      "Change type ID": {
        "count": "Number of changes of that type for the 
  specified status",
        "icon": "Change type icon",
        "id": "Change type ID",
        "name": "Change type name"
      },
      "total": {"count": "Total number of changes for the 
  specified status"}
    },
    "Other": {
      "Change type ID": {
        "count": "Number of changes of that type for the 
  specified status",
        "icon": "Change type icon",
        "id": "Change type ID",
        "name": "Change type name"
      },
      "total": {"count": "Total number of changes for the 
  specified status"}
    }
  },
  "totalSeverities": {
    "Other": {
      "Accepted": "Number of changes for the specified 
  severity and status",
      "Completed": "Number of changes for the specified 
  severity and status",
      "In Progress": "Number of changes for the specified 
  severity and status",
      "New": "Number of changes for the specified severity 
  and status",
      "total": {}
    },
    "S1": {
      "Accepted": "Number of changes for the specified 
  severity and status",
      "Completed": "Number of changes for the specified 
  severity and status",
      "In Progress": "Number of changes for the specified 
  severity and status",
      "New": "Number of changes for the specified severity 
  and status",
      "total": {}
    },
    "S2": {
      "Accepted": "Number of changes for the specified 
  severity and status",
      "Completed": "Number of changes for the specified 
  severity and status",
      "In Progress": "Number of changes for the specified 
  severity and status",
      "New": "Number of changes for the specified severity 
  and status",
      "total": {}
    }
  },
  "version": "Hibernate version number"
}

teams

{
  "automated": "'true' if the application is managed by an 
  integration provider or 'false' if it was created 
  manually",
  "createdByUserId": "ID of the user that created the 
  application",
  "dateCreated": "Timestamp that represents the date when 
  the application was created.",
  "description": "Application description",
  "ghostedDate": "Timestamp that represents the date when 
  the application has been deleted. If greater than 0, the 
  application has been removed.",
  "id": "Application ID",
  "level": "Application level: COMPONENT, APPLICATION, 
  SUITE",
  "name": "Application name",
  "teams": "[Array of teams  See: team TEMPLATE_NAME]",
  "version": "Hibernate version number"
}