initiatives resource

Resource that manages initiatives.

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.

list

{
  "dateCreated": "Timestamp that represents the date when 
  the initiative was created",
  "description": "Initiative description",
  "id": "Initiative ID",
  "name": "Initiative name",
  "version": "Hibernate version number"
}

detail

{
  "applications": "[Array of applications (See: 
  application TEMPLATE_LIST)]",
  "changes": "[Array of changes (See: change 
  TEMPLATE_LIST)]",
  "dateCreated": "Timestamp that represents the date when 
  the initiative was created",
  "description": "Initiative description",
  "id": "Initiative 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"
  },
  "name": "Initiative name",
  "properties": "Properties related to the integration",
  "releases": "[Array of releases (See: release 
  TEMPLATE_LIST)]",
  "version": "Hibernate version number"
}

externalIntegrationDetails

{
  "dateCreated": "Timestamp that represents the date when 
  the initiative was created",
  "description": "Initiative description",
  "id": "Initiative 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"
  },
  "name": "Initiative name",
  "properties": "Properties related to the integration",
  "version": "Hibernate version number"
}

externalIntegrationLight

{
  "externalId": "External Id",
  "externalUrl": "External Url",
  "id": "Initiative Id",
  "integrationProvider": "Integration provider name and id"
}