Developer Resources

API / (POST) Create Link

This API call creates a link and returns all links for the beetil..
HTTP-, API- or Beetil-specific errors will be returned otherwise.

API URL
https://youraccount.beetil.com/external_api/v1/links/:beetil_type/:beetil_id.format
HTTP Method
POST




URL parameters

ParameterFormatDefaultMandatory
beetil_typeThe name of the beetil (see Show Links).stringYes
beetil_idThe reference number of the beetil (see Show Links).integerYes




POST parameters

ParameterFormatDefaultMandatory
incident_idThe id of the incident you want to link with the beetil.integerYes
change_idThe id of the change you want to link with the beetil.integerYes
problem_idThe id of the problem you want to link with the beetil.integerYes
release_idThe id of the release you want to link with the beetil.integerYes




Points of Interest
  • Only one of the above POST parameters is necessary.
  • The beetil in the URL parameters will serve as the host that will be linked against.
  • All beetil types can be linked to all other beetil types, except problems to releases and vice versa.




Example POST
{
  "change_id": 234
}




Example POST Response
{
  "result": {
    "releases": [
      {
        "release_link": "/external_api/v1/links/incidents/33/releases/265",
        "release_id": 265
      }
    ],
    "incidents": [
      {
        "incident_link": "/external_api/v1/links/incidents/33/incidents/1234",
        "incident_id": 1234
      },
      {
        "incident_link": "/external_api/v1/links/incidents/33/incidents/678",
        "incident_id": 789
      }
    ],
    "changes": [
      {
        "release_link": "/external_api/v1/links/incidents/33/changes/234",
        "release_id": 234
      }
    ],
    "problems": [
      {
        "problem_id": 164,
        "problem_link": "/external_api/v1/links/incidents/33/problems/164"
      },
      {
        "problem_id": 165,
        "problem_link": "/external_api/v1/links/incidents/33/problems/165"
      },
      {
        "problem_id": 166,
        "problem_link": "/external_api/v1/links/incidents/33/problems/166"
      }
    ]
  },
  "version": "1.0",
  "status": "Success"
}




Example Error
{
  "errors": [
    {
      "error": "[E400] link cannot be created between problem and release"
    }
  ],
  "version": "1.0",
  "status": "Failed"
}




Last updated 31 January 2011