GET /bpm/businesscalendar/v1/timetables/{id}None.
The default content-type is application/json.
{
"description" : "Timetable Definition",
"type" : "object",
"properties" : {
"id" : { "type" : "string",
"description": "Timetable instance ID.",
"readonly" : "true" },
"uri" : { "type": "string",
"description": "Relative URI of the timetable.",
"readonly" : "true" },
"moduleName" : { "type": "string",
"description": "Name of the application module that contains this timetable.",
"readonly" : "true" },
"version" : { "type": "string",
"description": "Version of the application module that contains this timetable.",
"readonly" : "true" }
"tns" : { "type": "string",
"description": "Target namespace of the timetable.",
"readonly" : "true" },
"name" : { "type": "string",
"description": "Timetable name.",
"readonly" : "true" },
"events" : {
"type" : "array",
"items" : {
"descripton" : "Time Intervals in the timetable",
"type" : "object",
"properties" : {
"id" : { "type" : "string",
"description": "Instance ID of the timetable interval.",
"readonly" : "true" },
"uri" : { "type": "string",
"description": "Relative URI of the timetable interval.",
"readonly" : "true" },
"name" : { "type" : "string",
"description": "Name of the timetable interval."},
"description" : { "type" : "string",
"description": "description of the timetable interval."},
"available" : { "type" : "boolean",
"default": "true",
"description": "Indicates whether the time interval marks available time."},
"startTime" : { "type": "string",
"format": "date-time",
"description": "Specifies starting date and time of the time interval."},
"endTime" : { "type": "string",
"format": "date-time",
"optional": "true",
"description": "Specifies end date and time of the time interval. Either endTime or duration may exist."},
"originalTimezone" : { "type": "string",
"description": "The time zone of the startTime, endTime, and until properties. For example, GMT-08."},
"duration" : { "type": "string",
"optional": "true",
"description": "Duration of the time interval in xsd:duration like format PnDTnHnMnS. Either endTime or duration may exist."},
"rrule" : {
"type" : "object",
"optional": "true",
"description": "Recurrence rule specification",
"properties" : {
"frequency" : { "type": "string",
"description": "Identifies the type of recurrence rule."},
"until" : { "type": "string",
"format": "date-time",
"description": "The date and time till this recurrence rule repeats.",
"optional": "true" },
"count" : { "type": "integer",
"description": "Defines the number of recurrences.",
"optional": "true" },
"interval" : { "type" : "integer",
"default": "1",
"minimum": "1",
"description": "Specifies how often the time interval repeats."},
"byday" : { "type" : "string",
"description": "Specifies a comma character separated list of days of the week.",
"optional": "true"},
"bymonthday" : { "type" : "string",
"description": "Specifies a comma character separated list of days of the month.",
"optional": "true"},
"bymonth" : { "type" : "string",
"description": "Specifies a comma character separated list of months of the year.",
"optional": "true"}
}
}
}
}
},
"includes" : {
"type" : "array",
"items" : {
"descripton" : "Included Timetables",
"type" : "object",
"properties" : {
"id" : { "type" : "string",
"description": "Instance ID of the included timetable.",
"readonly" : "true" },
"uri" : { "type": "string",
"description": "Relative URI of the included timetable.",
"readonly" : "true" }
}
}
},
"excludes" : {
"type" : "array",
"items" : {
"descripton" : "Excluded Timetables",
"type" : "object",
"properties" : {
"id" : { "type" : "string",
"description": "Instance ID of the excluded timetable.",
"readonly" : "true" },
"uri" : { "type": "string",
"description": "Relative URI of the excluded timetable.",
"readonly" : "true" }
}
}
}
}
}
The default content-type is application/json.
{
"description" : "Timetable Error",
"type" : "object",
"properties" : {
"errorNumber" : { "type" : "string",
"description": "Message ID of the exception.",
"readonly" : "true" },
"errorMessage" : { "type" : "string",
"description": "Message text of the exception.",
"readonly" : "true" },
"programmerDetails" : { "type" : "string",
"description": "Additional exception details.",
"readonly" : "true",
"optional" : "true" }
}
}
| Code | Description |
|---|---|
| 200 OK |
Successful completion - requested data returned.
|
| 401 Unauthorized |
The caller is not authorized for this request.
|
| 500 Internal Server Error |
A severe problem has occurred, programmer's details are provided.
|
6.2.0
Parent Topic: Timetable Resource