GET
/
schedules
/
{schedule}
curl --request GET \
  --url http://localhost/api/schedules/{schedule}
{
  "data": {
    "id": "<string>",
    "type": "schedules",
    "attributes": {
      "id": "<string>",
      "name": "<string>",
      "message": "<string>",
      "status": {
        "human": "<string>",
        "value": "<string>"
      },
      "scheduled": {
        "human": "<string>",
        "string": "<string>"
      },
      "completed": {
        "human": "<string>",
        "string": "<string>"
      },
      "created": {
        "human": "<string>",
        "string": "<string>"
      },
      "updated": {
        "human": "<string>",
        "string": "<string>"
      }
    },
    "relationships": {
      "components": {
        "data": [
          {
            "id": "<string>",
            "type": "components",
            "attributes": {
              "id": "<string>",
              "name": "<string>",
              "description": "<string>",
              "link": "<string>",
              "order": "<string>",
              "status": {
                "human": "<string>",
                "value": "<string>"
              },
              "enabled": "<string>",
              "meta": "<string>",
              "created": {
                "human": "<string>",
                "string": "<string>"
              },
              "updated": {
                "human": "<string>",
                "string": "<string>"
              }
            },
            "relationships": {
              "group": {
                "data": {
                  "id": "<string>",
                  "type": "componentGroups",
                  "attributes": {
                    "id": "<string>",
                    "name": "<string>",
                    "order": "<string>",
                    "visible": "<string>",
                    "created": {
                      "human": "<string>",
                      "string": "<string>"
                    },
                    "updated": {
                      "human": "<string>",
                      "string": "<string>"
                    }
                  },
                  "relationships": {
                    "components": {
                      "data": [
                        {}
                      ]
                    }
                  }
                }
              },
              "incidents": {
                "data": [
                  {
                    "id": "<string>",
                    "type": "incidents",
                    "attributes": {
                      "id": "<string>",
                      "guid": "<string>",
                      "name": "<string>",
                      "message": "<string>",
                      "component_id": "<string>",
                      "visible": "<string>",
                      "stickied": "<string>",
                      "notifications": "<string>",
                      "status": {
                        "human": "<string>",
                        "value": "<string>"
                      },
                      "occurred": {
                        "human": "<string>",
                        "string": "<string>"
                      },
                      "created": {
                        "human": "<string>",
                        "string": "<string>"
                      },
                      "updated": {
                        "human": "<string>",
                        "string": "<string>"
                      }
                    },
                    "relationships": {
                      "components": {
                        "data": [
                          {}
                        ]
                      },
                      "updates": {
                        "data": [
                          {
                            "id": "<string>",
                            "type": "updates",
                            "attributes": {
                              "id": "<string>",
                              "updateable_id": "<string>",
                              "updateable_type": "<string>",
                              "message": "<string>",
                              "status": {
                                "human": "<string>",
                                "value": "<string>"
                              },
                              "created": {
                                "human": "<string>",
                                "string": "<string>"
                              },
                              "updated": {
                                "human": "<string>",
                                "string": "<string>"
                              }
                            }
                          }
                        ]
                      },
                      "user": {
                        "data": {
                          "id": "<string>",
                          "type": "<string>",
                          "attributes": {
                            "id": "<string>"
                          }
                        }
                      }
                    }
                  }
                ]
              }
            }
          }
        ]
      },
      "updates": {
        "data": [
          {
            "id": "<string>",
            "type": "updates",
            "attributes": {
              "id": "<string>",
              "updateable_id": "<string>",
              "updateable_type": "<string>",
              "message": "<string>",
              "status": {
                "human": "<string>",
                "value": "<string>"
              },
              "created": {
                "human": "<string>",
                "string": "<string>"
              },
              "updated": {
                "human": "<string>",
                "string": "<string>"
              }
            }
          }
        ]
      }
    }
  }
}

Path Parameters

​
schedule
integer
required

The schedule ID

Query Parameters

​
include
string

Available includes are components, componentsCount, componentsExists, updates, updatesCount, updatesExists, user, userCount, userExists. You can include multiple options by separating them with a comma.

Response

200
application/json
`Schedule`
​
data
object
required
Create ScheduleUpdate Schedule