NOTE: User must me logged in as agent or admin to access this API

URL : service-desk/api/release-list

Method : GET

Query Parameters :

Parameter Type Possible Values Required/Optional Description
sort-field String subject, release_number, planned_start_date, planned_end_date, created_at, updated_at Optional Field name to sort
sort-order String asc, desc Optional Sorting order either ascending or descending
search-query String any Optional Keyword to be searched in release list page
limit Integer any Optional Number of records to be displayed in each page
page Integer any Optional Page number
release_ids Array Array of integers Optional Array of release ids
status_ids Array Array of integers Optional Array of status ids
location_ids Array Array of integers Optional Array of location ids
priority_ids Array Array of integers Optional Array of priority ids
release_type_ids Array Array of integers Optional Array of release type ids
priority_ids Array Array of integers Optional Array of priority ids
planned_start_date String DateTime range for planned_start_date in format start_date~end_date (YYYY-MM-DD HH:MM:SS) Optional Release plan start time by which releases needs to be filtered
planned_end_date String DateTime range for planned_end_date in format start_date~end_date (YYYY-MM-DD HH:MM:SS) Optional Release plan end time by which releases needs to be filtered
asset_ids Array Array of integers Optional Array of asset ids
change_ids Array Array of integers Optional Array of change ids
created_at String DateTime range for created_at in format start_date~end_date (YYYY-MM-DD HH:MM:SS) Optional Release created time by which releases needs to be filtered
updated_at String DateTime range for updated_at in format start_date~end_date (YYYY-MM-DD HH:MM:SS) Optional Release updated time by which releases needs to be filtered

Success Response:

{
  "success": true,
  "data": {
    "current_page": 1,
    "first_page_url": "http://faveo-helpdesk-advance/public/service-desk/api/release-list?page=1",
    "from": 1,
    "last_page": 1,
    "last_page_url": "http://faveo-helpdesk-advance/public/service-desk/api/release-list?page=1",
    "next_page_url": null,
    "path": "http://faveo-helpdesk-advance/public/service-desk/api/release-list",
    "per_page": 10,
    "prev_page_url": null,
    "to": 2,
    "total": 2,
    "releases": [
      {
        "id": 2,
        "subject": "Replacing Router",
        "planned_start_date": "2020-02-12 19:00:00",
        "planned_end_date": "2020-02-12 21:00:00",
        "created_at": "2020-02-10 07:00:33",
        "updated_at": "2020-02-10 07:00:33",
        "release_type": {
          "id": 3,
          "name": "Major"
        },
        "priority": {
          "id": 3,
          "name": "High"
        },
        "status": {
          "id": 1,
          "name": "Open"
        },
        "release_number": "#REL-2"
      },
      {
        "id": 1,
        "subject": "Replacing Exchange Server 3",
        "planned_start_date": "2020-02-11 11:00:00",
        "planned_end_date": "2020-02-11 19:00:00",
        "created_at": "2020-02-10 06:57:23",
        "updated_at": "2020-02-10 06:57:23",
        "release_type": {
          "id": 2,
          "name": "Standard"
        },
        "priority": {
          "id": 1,
          "name": "Low"
        },
        "status": {
          "id": 1,
          "name": "Open"
        },
        "release_number": "#REL-1"
      }
    ]
  }
}

Leave a Reply

Your email address will not be published.