Retrieve Case Milestones

get

/cases/{id}/milestones

Retrieves case milestones.

• Request
• Response
• Examples

Request

There are no request parameters for this operation.

Response

Supported Media Types

• application/json
• application/xml

200 Response

Success

Body

Root Schema : /paths/~1cases~1{id}~1milestones/get/responses/200/schema

Example application/json

{
    "type":"milestones",
    "levels":0,
    "links":[
        {
            "rel":"back",
            "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c"
        },
        {
            "rel":"self",
            "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones"
        }
    ],
    "milestone":{
        "milestone":[
            {
                "name":"Lost",
                "state":"NOT_ATTAINED",
                "attain":{
                    "rel":"attain",
                    "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/Lost?action=attain"
                }
            },
            {
                "name":"Authorized",
                "state":"NOT_ATTAINED",
                "attain":{
                    "rel":"attain",
                    "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/Authorized?action=attain"
                }
            },
            {
                "name":"Returned",
                "state":"NOT_ATTAINED",
                "attain":{
                    "rel":"attain",
                    "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/Returned?action=attain"
                }
            },
            {
                "name":"InReservation",
                "state":"NOT_ATTAINED",
                "attain":{
                    "rel":"attain",
                    "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/InReservation?action=attain"
                }
            },
            {
                "name":"InRental",
                "state":"NOT_ATTAINED",
                "attain":{
                    "rel":"attain",
                    "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/InRental?action=attain"
                }
            },
            {
                "name":"InAccident",
                "state":"NOT_ATTAINED",
                "attain":{
                    "rel":"attain",
                    "href":"http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/InAccident?action=attain"
                }
            }
        ]
    }
}

Examples

The following example shows a response body when retrieving case milestones.

   {
                     "type": "milestones",
                     "levels": 0,
                     "links": [{
                     "rel": "back",
                     "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c"
                      },
                      {
                     "rel": "self",
                     "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones"
                       }],
                     "milestone": {
                     "milestone": [{
                     "name": "Lost",
                     "state": "NOT_ATTAINED",
                     "attain": {
                     "rel": "attain",
                     "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/Lost?action=attain"
                       }
                       },
                       {
                     "name": "Authorized",
                     "state": "NOT_ATTAINED",
                     "attain": {
                     "rel": "attain",
                     "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/Authorized?action=attain"
                      }
                       },
                      {
                      "name": "Returned",
                      "state": "NOT_ATTAINED",
                      "attain": {
                      "rel": "attain",
                      "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/Returned?action=attain"
                        }
                       },
                       {
                      "name": "InReservation",
                      "state": "NOT_ATTAINED",
                      "attain": {
                      "rel": "attain",
                      "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/InReservation?action=attain"
                        }
                        },
                         {
                      "name": "InRental",
                      "state": "NOT_ATTAINED",
                      "attain": {
                      "rel": "attain",
                      "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/InRental?action=attain"
                        }
                        },
                        {
                      "name": "InAccident",
                      "state": "NOT_ATTAINED",
                      "attain": {
                      "rel": "attain",
                       "href": "http://example.com/bpm/api/3.0/cases/5e4fa87f-d698-4c06-912c-79d162f4e03c/milestones/InAccident?action=attain"
                      }
                      }]
                       }
                      }

For more information about cURL, see Use cURL