Trends

>>>

GET /api/trends
List of trends counters

Examples

GET /api/trends
200
{
  "total": 2,
  "subtotal": 2,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2019-02-20 13:20:41 UTC",
      "updated_at": "2019-02-20 13:20:41 UTC",
      "id": 5,
      "trendable_type": "FactName",
      "trendable_id": 3,
      "fact_name": "fact41",
      "type": "FactTrend",
      "name": "trend2",
      "label": "trend2"
    },
    {
      "created_at": "2019-02-20 13:20:41 UTC",
      "updated_at": "2019-02-20 13:20:41 UTC",
      "id": 1,
      "trendable_type": "Environment",
      "trendable_id": 1,
      "fact_name": "fact",
      "type": "ForemanTrend",
      "name": "trend1",
      "label": "Environment"
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
>>>

GET /api/trends/:id
Show a trend

Examples

GET /api/trends/32
200
{
  "created_at": "2019-02-20 13:20:41 UTC",
  "updated_at": "2019-02-20 13:20:41 UTC",
  "id": 32,
  "trendable_type": "Environment",
  "trendable_id": 11,
  "fact_name": "fact",
  "type": "ForemanTrend",
  "name": "trend11",
  "label": "Environment"
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
trend_id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

POST /api/trends
Create a trend counter

Examples

POST /api/trends
{
  "trend": {
    "trendable_type": "NotExists"
  }
}
500
{
  "error": {
    "message": "uninitialized constant NotExists"
  }
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
trendable_type
required

Validations:

  • Must be a String
fact_name
optional

Validations:

  • Must be a String
name
optional

Validations:

  • Must be a String
>>>

DELETE /api/trends/:id
Delete a trend counter

Examples

DELETE /api/trends/12
{
  "trend": {}
}
200
{
  "id": 12,
  "trendable_type": "Environment",
  "trendable_id": 5,
  "name": "trend5",
  "fact_value": null,
  "fact_name": "fact",
  "created_at": "2019-02-20T13:20:41.567Z",
  "updated_at": "2019-02-20T13:20:41.567Z"
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.