Business Calendar - Timetable List Resource - GET Method

Retrieves the list of timetables that the current authenticated user either owns, has write access to, or read access to.

Resource URI

GET /bpm/businesscalendar/v1/timetables

Parameters

None.

Request Content

None.

Response Content

List of timetables the current user either owns, has write access to, or read access to.

The default content-type is application/json.

MIME Type: application/json

+ View Schema

{
    "description" : "Timetable List",
    "type" : "array",
    "items" : {
        "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" }
        "targetNamespace" : { "type": "string",
            "description": "Target namespace of the timetable.",
            "readonly" : "true" },
        "name" : { "type": "string",
            "description": "Timetable name.",
            "readonly" : "true" },
        "permissions" : {
            "type" : "array",
            "description": "Permissions available to the current authenticated user on this timetable.,
            "items" : {
                "name" : { "type": "string",
                    "enum": ["read","write","grant"],
                    "description": "The permission name."}
            }
        }
    }
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json

+ View Schema

{
    "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" }
    }
}

Status Codes

The method returns one of the following status codes:

Code	Description
200 OK	Successful completion - requested data returned. Note that the list may be empty.
500 Internal Server Error	A severe problem has occurred, programmer's details are provided.

Available Since

6.2.0

Parent Topic: Timetable List Resource