NAV Navbar
shell

Introduction

API Reference

Base URL

    https://app.eresourcescheduler.cloud/rest

eRS Cloud API is organized around Rest. Our API has predictable, resource-oriented URLs, and uses HTTP response codes to indicate API errors. We support cross-origin resource sharing, allowing you to interact securely with our API from a web application (though you should never expose your secret API key). JSON will be returned by all API responses including errors. Use our API to access eRS Cloud API end-points, which can get you information of resources, projects and booking in our database.

Authentication

Every eRS Cloud API endpoint requires an access token. If token is not passed or is invalid, API will return 401 Unauthorized error.

An access token can be generated at User Profile -> Security.

Alternatively, OAuth flow can be used to obtain a token if access is required by third party application.

OAuth

eRS Cloud API allows access using OAuth 2 code flow to enable integration with third party applications. OAuth 2 is an open standard for authorization that enables third party applications to obtain access of API on behalf of user who wishes to approve access.

Developer (having admin access to eRS Cloud) are require to register an application to use OAuth. Once application is registered, it is assigned a client Id and client secret. The client secret should be kept confidential and only use when authorizing between application and eRS cloud authorization server.

Example : Authorization Link

https://app.eresourcescheduler.cloud/login/oauth/authorize?
response_type=code
&client_id=SZIZIzFXUKfwnUJW
&redirect_uri=https://example.com/oauth/callback
&state=f2g5h3b5

1. Request User Authorization

Give user an authorization link which redirects to eRS Cloud authorization server. If using a phone or desktop app instead of a browser, this could be achieved using some browser plugin.

Grant Code Request Endpoint.

https://app.eresourcescheduler.cloud/login/oauth/authorize

Parameters: Auth Code Request

Name Description
client_id
string required
eRS Cloud generated unique client id which was assigned while registering application.
redirect_uri
string required
The callback url where user will be sent back after authorization. This value must match to redirect uri, given at the time of application registration.
response_type
string required
This must be set to "code" for obtaining grant code.
state
string optional
It is used to identify or verify origin of request. Usually it is a random string which is passed along with this request and expect the same when eRS Cloud redirects back to defined redirect uri after authorization.

Example : Access Token Request

curl -X POST "https://app.eresourcescheduler.cloud/login/oauth/token?\
grant_type=authorization_code\
&code=QbD76mCzJSMJt4fc892i\
&client_id=SZIZIzFXUKfwnUJW\
&client_secret=4pbxCfKa1kJB2nihfbtPLixtv6Tf4V5q\
&redirect_uri='https://example.com/oauth/callback'" \
-H "Content-Type:application/x-www-form-urlencoded"

2. Request Access Token

Once authorization is complete, eRS Cloud sends redirect back to defined redirect_uri with a grant code parameter "code" (and state parameter if was issued at time of requesting grant code) set.

Now this grant code can be used to fetch access token from token end point.

Access Token Request Endpoint.

https://app.eresourcescheduler.cloud/login/oauth/token

Parameters: Auth Code Request

Name Description
grant_type
string required
This must be set to "authorization_code" for access token request.
code
string required
The grant code which was received in step 1.
client_id
string required
eRS Cloud generated unique client id which was assigned while registering application.
client_secret
string required
The client secret which was assigned while registering application.
redirect_uri
string required
The callback url where user will be sent back after authorization. This value must match to redirect uri, given at the time of application registration.

To learn more about OAuth token generation flow please read here.

eRS Cloud expects an API token to be included in all API requests to in a header that looks like the following:

Authorization: Bearer B8x5Vj1O65r6wnoV

A sample API token is included in all the example request in this document. To test requests using your account, replace the sample access token with your actual access token.

Response Codes

eRS Cloud uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed due to incorrect request. (e.g., a required parameter was omitted, syntactically incorrect request, etc.). Codes in the 5xx range indicate an error with eRS Cloud's servers (which is rare).

List of Status Codes :

Status Code Meaning
200
OK
Everything worked as expected.
201
Created
This indicates successful creation of intended object.
400
Bad Request
Indicates that request is not acceptable, often due to missing required parameters or invalid value for any parameter.
401
Unauthorized
No valid API access token provide. Authentication failed due to invalid authentication credentials.
403
Forbidden
Accessing an object or performing an action when user doesn't have required permissions, causes this error.
404
Not Found
The requested resource doesn't exist.
405
Method Not Allowed
HTTP method is not allowed by a web server for a requested URL.
409
Conflict
Occurs when trying to create a duplicate object where duplicates are not allowed or when request could affect other objects.
415
Unsupported Media Type
No valid media is provided.
500
Internal Server Error
Something went wrong at eRS's end. (This is rare.)

User Defined Fields

Example Response:

{
  ...
  "emp_birthday": "1997-01-27",
  "qualification": "MBA"
  ...
}

As the name shows, these fields are user-defined custom fields. A user with admin rights can add such custom fields using eRS Cloud Application. These fields can be used to capture additional information in Resource, Project and Booking forms.

User defined fields are filterable. Also, user can configure the visibility of such fields in the different forms, for example a field named employee_id can be created which is meant only for Employee type of resources.

There are fifteen types of different fields available for different use cases. Each type of field has its own set of attributes which can be configured to fit your requirements. Once such fields are added and applied, the response for that object will contain these along with normal attributes.

Types of User Defined Fields

User can create one of the following type of field.

Name Description
Simple Text
string
Allows user to enter any combination of letters and numbers. Also, it can be configured to have different validations like min length, max length and regex pattern to fit most requirements.
Multi Line Rich Text
string
Allows user to enter long rich text (up to 2000 characters). This type of field allows formatting such as adding headers, paragraphs, hyperlinks, bold and italic text etc.
Integer Number
integer
Allows user to enter numeric data. This is useful for fields like emp_id, ref_no etc. These fields can be configured to have validations like min number and max number.
Fractional Number
number
Allows user to enter floating point number. This is useful for fields like geo_coordinates, mean_distance etc. This type of field can also have validations like min number and max number.
Date
string
Allows user to enter date value from a popup calendar. This field takes input in ISO 8601 extended notation for date value i.e. yyyy-MM-dd. Example use case of this type of fields could be like emp_birth_dae, date_of_delivery, date_of_completion etc. Available validations for these fields are min date and max date.
DateTime
string
This type of field can be used where a specific instant of time needs to be recorded. This field takes input in ISO 8601 extended notation for date and time value i.e. yyyy-MM-ddTHH:mm:ssZ. This field support time zone offset as well. Example use case of this type of fields could be like eta, generated_at etc.
URL
string
Allows user to enter a valid link address. This field takes string input which should be a valid URL. This type of fields could be used to store a hyperlink to a website or a network resource.
Email
string
Allows user to enter an email address, which is validated to ensure the proper format.
Checkbox
boolean
Allows user to select or deselect a value using checkbox. This field takes a boolean value as input. Example use case could be like is_enabled, is_active etc.
Radio Group
integer
Allows user to select single value from available values. This field can be configured to have multiple options which user can select one from.
Drop Down Single Select
integer
Allows user to select a single value from the dropdown list of available options. This field can be configured to have a pick list of multiple options which user can select one from.
Checkbox Group
integer array
Allows user to select one or more values from a group of check boxes. This is useful where user needs to pick multiple values from available options. This field can be configured to have a pick list of multiple options which user can select from.
Dropdown Multi select
integer array
Allows user to select multiple values from the dropdown list. This field can be configured to have a pick list of multiple options which user can select from. Though it is similar to checkbox group field, it additionally allows to search from available options and is recommended when there are large number of options.
Color Picker
string
Allows user to store a color code for an object. This is useful to visually identity an object when presenting in user interface. This field takes input in string format of hexadecimal color code with foreground color separated by semicolon ; i.e #XXXXXX;1/0. Here X represent hexadecimal digit for background color, 1 represents white foreground color and 0 represents black foreground color. For example if red background with white foreground (text color) needs to be stored, then value should be #FF0000;1.
Label
integer
Allows user to select a single value with color, from the dropdown list. This field can be configured to have a pick list of multiple options which user can select one from. These fields are useful for visual representation of meaningful labels. For example a field named status can be created having options such as Active , On Hold, Delayed .

Resource Types

Resource Type Object

Example Response

{
  "id": 1,
  "name": "Employee",
  "description": "",
  "is_human": true,
  "fields": [{
      "id": 52,
      "code": "udf_department",
      "display_name": "Department",
      "field_type": "DDSS",
      "is_required": false,
      "is_system_defined": false,
      "options": [{
          "id": 27,
          "name": "Service",
          "description": null
        },
        {
          "id": 26,
          "name": "Technical",
          "description": null
        },
        { ... }
      ]
    }, {
      "id": 11,
      "code": "email",
      "display_name": "Email",
      "field_type": "EMAIL",
      "placeholder_text": "Enter valid email id",
      "maxlength": 254,
      "regex": "^[a-zA-Z]+[a-zA-Z0-9._]+@[a-zA-Z]+\\.[a-zA-Z.]{2,5}$",
      "is_required": false,
      "is_system_defined": true
    }, {
      "id": 46,
      "code": "udf_employee_no",
      "display_name": "Employee No.",
      "field_type": "TEXT",
      "minlength": 1,
      "maxlength": 10,
      "is_required": false,
      "is_system_defined": false
    }, {
      "id": 7,
      "code": "first_name",
      "display_name": "First Name",
      "field_type": "TEXT",
      "help_text": "",
      "placeholder_text": "Enter first name",
      "minlength": 1,
      "maxlength": 100,
      "is_required": true,
      "is_system_defined": true
    }, {
      "id": 8,
      "code": "last_name",
      "display_name": "Last Name",
      "field_type": "TEXT",
      "placeholder_text": "Enter last name",
      "maxlength": 100,
      "is_required": false,
      "is_system_defined": true
    }, {
      "id": 14,
      "code": "last_date",
      "display_name": "Last Working Date",
      "field_type": "DATE",
      "is_required": false,
      "is_system_defined": true,
      "maxdate": "2099-12-31",
      "mindate": "1900-01-01"
    }, {
      "id": 45,
      "code": "udf_office",
      "display_name": "Office",
      "field_type": "DDSS",
      "is_required": false,
      "is_system_defined": false,
      "options": [{
          "id": 8,
          "name": "Chicago",
          "description": null
        }, {
          "id": 11,
          "name": "Dallas",
          "description": null
        }, {
          "id": 10,
          "name": "New York",
          "description": null
        }, {
          "id": 12,
          "name": "San Francisco",
          "description": null
        }, {
          "id": 9,
          "name": "Washington",
          "description": null
        },
        { ... }
      ]
    }, {
      "id": 26,
      "code": "phone",
      "display_name": "Phone",
      "field_type": "TEXT",
      "maxlength": 50,
      "is_required": false,
      "is_system_defined": true
    },
    { ... }
  ]
}

Resource type object represents the type of resource. In an organization, there can be multiple types of resources. Administrator can add multiple resource types using eRS Cloud application. Resource type can be categorized as human or non-human. Human type of resource can be Employee, Contractor, etc. and non-human can be Meeting Rooms, Projectors etc. Different resource type object can be configured to have different set of custom attributes as well, which allows customizing resource objects to fit your requirements.

ATTRIBUTES

Name Description
id
integer
Unique identification number for the object, which allows referring to this object and can be used to search a particular resource type.
name
string
Represent name for this object. This is used to identify object by using some meaningful phrase to describe type of resources like Employee, Machine etc.
is_human
boolean
Indicates whether this resource type is human or non-human. For example, Employee could be a human resource type while Machine, Meeting Rooms etc. can be non-human resource type.
fields
array of object
Represent collection of fields (or attributes) that are available for this resource type. Each Resource object of this resource type can store / update values for these filed. While creating or updating a Resource user must pass arguments which are available for intended resource type object.
field.id
integer
Represents unique identification number of this field, which can be used to refer or search it.
field.display_name
string
Name of this field to identify it.
field.field_type
string
Represents the type of field. For example TEXT (for Text Field), INT (for Integer Number field), DDSS (for Dropdown Single Select Field), etc. See User Defined Fields to know more about different field types.
field.code
string
It represents the unique code of the field which is referred to as API code. This code acts as key in API response and the same must be used as key to pass values for a POST or PUT request.
field.minlength
integer
Represents minimum no of characters in value this field can accept (only applicable for text fields).
field.maxlength
integer
Represents maximum no of characters in value this field can accept (only applicable for text fields).
field.regex
string
Represents regular expression which must be matched by value for this field (only applicable for text fields).
field.minnum
integer
Represents minimum value this field can accept (only applicable for numeric fields).
field.maxnum
integer
Represents maximum value this field can accept (only applicable for numeric fields).
field.mindate
string
Represents minimum value this field can accept (only applicable for date / date time fields).
field.maxdate
string
Represents maximum value this field can accept (only applicable for date / date time fields).
field.is_required
boolean
Indicates whether this field is mandatory or not. If this field is a required field then a valid value for this field must be passed while creating such object and while updating object (if this field is intended to update).
is_system_defined
boolean
Indicates whether this field is system defined or a custom field. Fields which are system defined can not be customized.
field.options
array of objects
Field types such as Dropdown Single Select, Dropdown Multi Select, Radio Group etc. ( See User Defined Fields to know more. ) allow user to pick one or more from these available options.
field.option.id
integer
Represents unique identification number for the individual option object.
field.option.name
string
Represents name or content of option object.

Get a Specific Resource Type

Retrieves the details of an existing resource-type. You only need to provide the unique resource-type identifier of required resource-type.

GET /v1/resourcetypes/{ID}

Example Request

curl -v \
"https://app.eresourcescheduler.cloud/rest/v1/resourcetypes/2" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV"

Example Response

{
  "id": 1,
  "name": "Employee",
  "description": "",
  "is_human": true,
  "fields": [{
      "id": 52,
      "code": "udf_department",
      "display_name": "Department",
      "field_type": "DDSS",
      "is_required": false,
      "is_system_defined": false,
      "options": [{
          "id": 27,
          "name": "Service",
          "description": null
        },
        {
          "id": 26,
          "name": "Technical",
          "description": null
        },
        { ... }
      ]
    }, {
      "id": 11,
      "code": "email",
      "display_name": "Email",
      "field_type": "EMAIL",
      "placeholder_text": "Enter valid email id",
      "maxlength": 254,
      "regex": "^[a-zA-Z]+[a-zA-Z0-9._]+@[a-zA-Z]+\\.[a-zA-Z.]{2,5}$",
      "is_required": false,
      "is_system_defined": true
    }, {
      "id": 46,
      "code": "udf_employee_no",
      "display_name": "Employee No.",
      "field_type": "TEXT",
      "minlength": 1,
      "maxlength": 10,
      "is_required": false,
      "is_system_defined": false
    }, {
      "id": 7,
      "code": "first_name",
      "display_name": "First Name",
      "field_type": "TEXT",
      "help_text": "",
      "placeholder_text": "Enter first name",
      "minlength": 1,
      "maxlength": 100,
      "is_required": true,
      "is_system_defined": true
    }, {
      "id": 8,
      "code": "last_name",
      "display_name": "Last Name",
      "field_type": "TEXT",
      "placeholder_text": "Enter last name",
      "maxlength": 100,
      "is_required": false,
      "is_system_defined": true
    }, {
      "id": 14,
      "code": "last_date",
      "display_name": "Last Working Date",
      "field_type": "DATE",
      "is_required": false,
      "is_system_defined": true,
      "maxdate": "2099-12-31",
      "mindate": "1900-01-01"
    }, {
      "id": 45,
      "code": "udf_office",
      "display_name": "Office",
      "field_type": "DDSS",
      "is_required": false,
      "is_system_defined": false,
      "options": [{
          "id": 8,
          "name": "Chicago",
          "description": null
        }, {
          "id": 11,
          "name": "Dallas",
          "description": null
        }, {
          "id": 10,
          "name": "New York",
          "description": null
        }, {
          "id": 12,
          "name": "San Francisco",
          "description": null
        }, {
          "id": 9,
          "name": "Washington",
          "description": null
        },
        { ... }
      ]
    }, {
      "id": 26,
      "code": "phone",
      "display_name": "Phone",
      "field_type": "TEXT",
      "maxlength": 50,
      "is_required": false,
      "is_system_defined": true
    },
    { ... }
  ]
}

Returns

Code Description
200
OK
Indicates that operation was successful and retrieved a resource-type successfully.
403
Forbidden
Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
404
Not Found
Indicates that no resource-type object was found with provided identifier.

Get All Resource Types

Returns a list of all resource-types sorted by name.

GET /v1/resourcetypes

Example Request

curl -v \
"https://app.eresourcescheduler.cloud/rest/v1/resourcetypes" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV"

Example Response

{
  "total_count": 4,
  "data": [{
      "id": 1,
      "name": "Employee",
      "description": "",
      "is_human": true,
      "fields": [{
          "id": 52,
          "code": "udf_department",
          "display_name": "Department",
          "field_type": "DDSS",
          "is_required": false,
          "is_system_defined": false,
          "options": [{
              "id": 27,
              "name": "Service",
              "description": null
            },
            {
              "id": 26,
              "name": "Technical",
              "description": null
            },
            { ... }
          ]
        }, {
          "id": 11,
          "code": "email",
          "display_name": "Email",
          "field_type": "EMAIL",
          "placeholder_text": "Enter valid email id",
          "maxlength": 254,
          "regex": "^[a-zA-Z]+[a-zA-Z0-9._]+@[a-zA-Z]+\\.[a-zA-Z.]{2,5}$",
          "is_required": false,
          "is_system_defined": true
        }, {
          "id": 46,
          "code": "udf_employee_no",
          "display_name": "Employee No.",
          "field_type": "TEXT",
          "minlength": 1,
          "maxlength": 10,
          "is_required": false,
          "is_system_defined": false
        }, {
          "id": 7,
          "code": "first_name",
          "display_name": "First Name",
          "field_type": "TEXT",
          "help_text": "",
          "placeholder_text": "Enter first name",
          "minlength": 1,
          "maxlength": 100,
          "is_required": true,
          "is_system_defined": true
        }, {
          "id": 8,
          "code": "last_name",
          "display_name": "Last Name",
          "field_type": "TEXT",
          "placeholder_text": "Enter last name",
          "maxlength": 100,
          "is_required": false,
          "is_system_defined": true
        }, {
          "id": 14,
          "code": "last_date",
          "display_name": "Last Working Date",
          "field_type": "DATE",
          "is_required": false,
          "is_system_defined": true,
          "maxdate": "2099-12-31",
          "mindate": "1900-01-01"
        }, {
          "id": 26,
          "code": "phone",
          "display_name": "Phone",
          "field_type": "TEXT",
          "maxlength": 50,
          "is_required": false,
          "is_system_defined": true
        },
        { ... }
      ]
    },
    { ... }
  ]
}

Returns

Code Description
200
OK
This indicates that the operation was successful and list of resource-types is returned.
403
Forbidden
Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.

Projects Types

Project type object

Example Response

{
  "id": 1,
  "name": "Standard",
  "description": "",
  "fields": [
      {
        "id": 39,
        "code": "is_archive",
        "display_name": "Archive",
        "field_type": "ARCH",
        "is_required": false,
        "is_system_defined": true
      },
      {
        "id": 40,
        "code": "color",
        "display_name": "Color",
        "field_type": "COLPICK",
        "is_required": false,
        "is_system_defined": false
      },
      {
        "id": 11,
        "code": "email",
        "display_name": "Email",
        "field_type": "EMAIL",
        "placeholder_text": "Enter valid email id",
        "maxlength": 254,
        "regex": "^[a-zA-Z]+[a-zA-Z0-9._]+@[a-zA-Z]+\.[a-zA-Z.]{2,5}$",
        "is_required": false,
        "is_system_defined": true
      },
      {
        "id": 15,
        "code": "end_date",
        "display_name": "End Date",
        "field_type": "DATE",
        "is_required": false,
        "is_system_defined": true,
        "mindate": "1900-01-01",
        "maxdate": "2099-12-31"
      },
      {
        "id": 10,
        "code": "title",
        "display_name": "Project Name",
        "field_type": "ENAME",
        "minlength": 1,
        "maxlength": 100,
        "is_required": true,
        "is_system_defined": true
      },
      {
        "id": 101,
        "code": "manager",
        "display_name": "Manager",
        "field_type": "DDSS",
        "is_required": false,
        "is_system_defined": false,
        "options": [
            {
              "id": 107,
              "name": "Chester Norman",
              "description": null
            },
            {...}
        ]
      },
      {
        "id": 13,
        "code": "project_start_date",
        "display_name": "Start Date",
        "field_type": "DATE",
        "is_required": false,
        "is_system_defined": true,
        "mindate": "1900-01-01",
        "maxdate": "2099-12-31"
      },
      {
        "id": 32,
        "code": "tags",
        "display_name": "Tags",
        "field_type": "TAGS",
        "is_required": false,
        "is_system_defined": true
      }
    ]
}

Project type object represents the type of project. In an organization, there can be multiple types of projects. Administrator can add multiple project types using eRS Cloud application. Different project type object can be configured to have different set of custom attributes as well, which allows customizing project objects to fit your requirements.

ATTRIBUTES

Name Description
id
integer
Unique identification number for the object, which allows referring to this object and can be used to search a particular project type.
name
string
Represent name for this object. This is used to identify object by using some meaningful phrase to describe type of projects like Standard, Education etc.
fields
array of strings
Represent collection of fields (or attributes) that are available for this project type. Each Project object of this project type can store / update values for these filed. While creating or updating a Project user must pass arguments which are available for intended project type object.
field.id
integer
Represents unique identification number of this field, which can be used to refer or search it.
field.display_name
string
Name of this field to identify it.
field.field_type
string
Represents the type of field. For example TEXT (for Text Field), INT (for Integer Number field), DDSS (for Dropdown Single Select Field), etc. See User Defined Fields to know more about different field types.
field.code
string
It represents the unique code of the field which is referred to as API code. This code acts as key in API response and the same must be used as key to pass values for a POST or PUT request.
field.minlength
integer
Represents minimum no of characters in value this field can accept (only applicable for text fields).
field.maxlength
integer
Represents maximum no of characters in value this field can accept (only applicable for text fields).
field.regex
string
Represents regular expression which must be matched by value for this field (only applicable for text fields).
field.minnum
integer
Represents minimum value this field can accept (only applicable for numeric fields).
field.maxnum
integer
Represents maximum value this field can accept (only applicable for numeric fields).
field.mindate
string
Represents minimum value this field can accept (only applicable for date / date time fields).
field.maxdate
string
Represents maximum value this field can accept (only applicable for date / date time fields).
field.is_required
boolean
Indicates whether this field is mandatory or not. If this field is a required field then a valid value for this field must be passed while creating such object and while updating object (if this field is intended to update).
is_system_defined
boolean
Indicates whether this field is system defined or a custom field. Fields which are system defined can not be customized.
fields.options
string
Field types such as Dropdown Single Select, Dropdown Multi Select, Radio Group etc. ( See User Defined Fields to know more. ) allow user to pick one or more from these available options.
field.option.id
integer
Represents unique identification number for the individual option object.
field.option.name
string
Represents name or content of option object.

Get a Specific Project Type

Retrieves the details of an existing project-type. You only need to provide the unique project-type identifier that was returned upon project-type creation.

GET /v1/projecttypes/{ID}

Example Request

curl -v \
"https://app.eresourcescheduler.cloud/rest/v1/projecttypes/3" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV"

Example Response

{

    "id": 3,
    "name": "Education",
    "description": "",
    "fields": [
      {
        "id": 39,
        "code": "is_archive",
        "display_name": "Archive",
        "field_type": "ARCH",
        "is_required": false,
        "is_system_defined": true
      },
      {
        "id": 104,
        "code": "department",
        "display_name": "Department",
        "field_type": "RDGRP",
        "is_required": false,
        "is_system_defined": false,
        "options": [
             {
                "id": 117,
                "name": "Accounts",
                "description": null
             },
             {...}   
          ],
      },
      {
        "id": 11,
        "code": "email",
        "display_name": "Email",
        "field_type": "EMAIL",
        "placeholder_text": "Enter valid email id",
        "maxlength": 254,
        "regex": "^[a-zA-Z]+[a-zA-Z0-9._]+@[a-zA-Z]+\.[a-zA-Z.]{2,5}$",
        "is_required": false,
        "is_system_defined": true
      },
      {
        "id": 15,
        "code": "end_date",
        "display_name": "End Date",
        "field_type": "DATE",
        "is_required": false,
        "is_system_defined": true,
        "mindate": "1900-01-01",
        "maxdate": "2099-12-31"
      },
      {...},
      {...} 
    ]
}

Returns

Code Description
200
OK
This status code indicates that the operation was successful and a project-type get retrieved successfully .
403
Forbidden
Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
404
Not Found
This status code indicates that project-type id does not exist

Get All Projects Types

Returns a list of project-types. The project-types are returned sorted by name.

GET /v1/projecttypes

Example Request

curl -v \
"https://app.eresourcescheduler.cloud/rest/v1/projecttypes" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV"

Example Response

{
  "total_count": 4,
  "data": [
    {
      "id": 3,
      "name": "Education",
      "description": "",
      "fields": [
        {
          "id": 39,
          "code": "is_archive",
          "display_name": "Archive",
          "field_type": "ARCH",
          "is_required": false,
          "is_system_defined": true
        },
        {
          "id": 104,
          "code": "department",
          "display_name": "Department",
          "field_type": "RDGRP",
          "is_required": false,
          "is_system_defined": false,
          "options": [
              {
                  "id": 117,
                  "name": "Accounts",
                  "description": null
              },
              {...}   
            ],
        },
        {
          "id": 11,
          "code": "email",
          "display_name": "Email",
          "field_type": "EMAIL",
          "placeholder_text": "Enter valid email id",
          "maxlength": 254,
          "regex": "^[a-zA-Z]+[a-zA-Z0-9._]+@[a-zA-Z]+\.[a-zA-Z.]{2,5}$",
          "is_required": false,
          "is_system_defined": true
        },
        {
          "id": 15,
          "code": "end_date",
          "display_name": "End Date",
          "field_type": "DATE",
          "is_required": false,
          "is_system_defined": true,
          "mindate": "1900-01-01",
          "maxdate": "2099-12-31"
        },
        {...},
        {...} 
      ]
    },
    {...},
    {...}
  ]
}

Returns

Code Description
200
OK
This indicates that the operation was successful and list of project-types is returned.
403
Forbidden
Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.

Booking Profile

Booking profile object

Booking profile object represents booking profile.

/v1/booking/fields

Example Request

curl -v \
"https://app.eresourcescheduler.cloud/rest/v1/booking/fields" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV"

Example Response

{
    "id": 29,
    "code": "effort",
    "display_name": "Effort",
    "field_type": "EFFORT",
    "minnum": 0,
    "is_required": false,
    "is_system_defined": true,
    "is_filterable": false
},
{
    "id": 17,
    "code": "end_time",
    "display_name": "Ends",
    "field_type": "DATIM",
    "is_required": true,
    "is_system_defined": true,
    "is_filterable": false,
    "maxdate": "2099-12-31",
    "mindate": "1900-01-01"
},
{
    "id": 31,
    "code": "role_id",
    "display_name": "Performing Role",
    "field_type": "ROLEPS",
    "is_required": false,
    "is_system_defined": true,
    "is_filterable": true,
    "options": [
         {
            "id": 5,
            "name": "Architect",
            "description": null
         },
         {...},
         {...}
    ]
},
{
    "id": 3,
    "code": "project_id",
    "display_name": "Project",
    "field_type": "PRJSS",
    "is_required": true,
    "is_system_defined": true,
    "is_filterable": false
},
{
    "id": 2,
    "code": "resource_id",
    "display_name": "Resource",
    "field_type": "RSRSS",
    "is_required": true,
    "is_system_defined": true,
    "is_filterable": false
},
{
    "id": 16,
    "code": "start_time",
    "display_name": "Starts",
    "field_type": "DATIM",
    "is_required": true,
    "is_system_defined": true,
    "is_filterable": false,
    "maxdate": "2099-12-31",
    "mindate": "1900-01-01"
},
{
    "id": 32,
    "code": "tags",
    "display_name": "Tags",
    "field_type": "TAGS",
    "is_required": false,
    "is_system_defined": true,
    "is_filterable": true
},
{
    "id": 30,
    "code": "task_id",
    "display_name": "Task",
    "field_type": "TSKSS",
    "is_required": false,
    "is_system_defined": true,
    "is_filterable": false
},
{
    "id": 5,
    "code": "unit",
    "display_name": "Unit",
    "field_type": "UNIT",
    "minnum": 1,
    "maxnum": 5,
    "is_required": false,
    "is_system_defined": true,
    "is_filterable": false
}

ATTRIBUTES

Name Description
id
integer
Represents unique identification number of this field, which can be used to refer or search it.
code
integer
It represents the unique code of the field which is referred to as API code. This code acts as key in API response and the same must be used as key to pass values for a POST or PUT request.
field_type
string
Represents the type of field. For example TEXT (for Text Field), INT (for Integer Number field), DDSS (for Dropdown Single Select Field), etc. See User Defined Fields to know more about different field types.
display_name
string
Name of this field to identify it.
is_system_defined
boolean
Indicates whether this field is system defined or a custom field. Fields which are system defined can not be customized.
is_filterable
boolean
Indicates whether this field is used for filtering or not.
is_required
boolean
Indicates whether this field is mandatory or not. If this field is a required field then a valid value for this field must be passed while creating such object and while updating object (if this field is intended to update).
minnum
integer
Represents minimum value this field can accept (only applicable for numeric fields).
maxnum
integer
Represents maxmum value this field can accept (only applicable for numeric fields).
mindate
string
Represents minimum value this field can accept (only applicable for date / date time fields).
maxdate
string
Represents maxmum value this field can accept (only applicable for date / date time fields).

Calendars

Calendar object

Calendar is used to define working-timing of resources. An admin user can define multiple calendars using eRS Cloud application. Each calendar may have different timings defined. Timings allows breaks and multiple timing blocks. In addition to timings, user can apply holidays and exceptions (working or non-working) on calendars. A particular calendar can be applied on a set of resources and a resource can also have multiple calendars on different periods. eRS Cloud API allows getting details of calendars.

Example Response

{
    "id": 2,
    "name": "New York Calendar",
    "description": null,
    "is_default": false,    
    "timings": [{
        "day_num": 1,
        "start_time": 540,
        "end_time": 1020
    }, {
        "day_num": 2,
        "start_time": 540,
        "end_time": 1020
    }, {
        "day_num": 3,
        "start_time": 540,
        "end_time": 1020
    }, {
        "day_num": 4,
        "start_time": 540,
        "end_time": 1020
    }, {
        "day_num": 5,
        "start_time": 540,
        "end_time": 1020
    }],
    "holidays": [{
        "id": 1,
        "name": "Christmas Day",
        "description": null,
        "date": "2018-12-25",
        "tags": []
    }],
    "exceptions": [{
        "id": 1,
        "name": "Over Time",
        "description": null,
        "date": "2018-12-20",
        "is_working_exception": true,
        "tags": [],
        "timings": [{
            "start_time": 540,
            "end_time": 1140
        }]
    }],
    "created_on": "2018-08-21T10:03:08.650207+00:00",
    "modified_on": "2018-12-03T15:09:34.697541+00:00",
    "created_by": {
        "id": 118,
        "name": "John Doe"
    },
    "modified_by": {
        "id": 118,
        "name": "John doe"
    }
}

ATTRIBUTES

Name Description
id
integer
Unique identifier for the object.
name
string
A meaningful name to identify this calendar object.
description
string
Description for calendar object.
is_default
boolean
Indicates whether this calendar object is used as a default calendar or not. There can only be one (which can be changed) default calendar at a time. Default calendar gets applied as working calendar, if calendar not specified while creating a resource.
timings
array of objects
List of timing objects applicable for this calendar object. Timing objects (or timing blocks) are used to define working capacity for each day of week.
timing.day_num
integer
Represents day of week, starting from 0 (for Sunday) to 6 (for Saturday).
timing.start_time
integer
Represents start time for this timing block in minutes (since 12 AM) i.e. for 6:00 AM, value would be 6 * 60 = 360 and for 9:00 AM it would be 9 * 60 = 540.
timing.end_time
integer
Represents end time for this timing block in minutes (since 12 AM) i.e. for 5:00 PM, value would be (12+5) * 60 = 1020.
holidays
array of objects
List of holiday objects applied for this calendar. There can be multiple holidays applied on calendar.
holiday.id
integer
Unique identifier for holiday object.
holiday.name
string
Name of holiday.
holiday.description
string
Description for this holiday object.
holiday.date
string
Represents date on which holiday occurs. This is a string value in ISO 8601 extended Date format i.e. yyyy-mm-dd.
holiday.tags
array of string
Tags are the list of strings (labels) attached to this holiday object which could be used for the purpose of identification or other information.
exceptions
array of objects
List of exception objects that are applied on calendar object. Exceptions are used to override working timing of calendar for a specified day.
exception.id
integer
Unique identifier for exception object.
exception.name
string
Name of exception object (which is to be displayed wherever referred).
exception.description
string
Description for exception object.
exception.date
string
Represents date on which exception is to be applied. This is a string value in ISO 8601 extended Date format i.e. yyyy-mm-dd.
exception.is_working_exception
boolean
Indicates whether this exception is working exception or non-working. A working exception is used to override timings of a working day and if applied on a non-working day, it turns it into working day. A non-working exception turns any working day into non-working.
exception.timings
array of objects
List of timing objects (or timing blocks) for this exception. This defines working timings for this exception day. There are no timings if exception is a non-working exception.
exception.timing.start_time
integer
Represents start time for this timing block in minutes (since 12 AM) i.e. for 6:00 AM, value would be 6 * 60 = 360 and for 9:00 AM it would be 9 * 60 = 540.
exception.timing.end_time
integer
Represents end time for this timing block in minutes (since 12 AM) i.e. for 5:00 PM, value would be (12+5) * 60 = 1020.
exception.tags
array of string
Tags are the list of strings (labels) attached to this exception object which could be used for the purpose of identification or other information.
created_on
string
Timestamp at which calendar object was created.
modified_on
string
Describes the latest modification timestamp.
created_by
object
Describes by whom calendar object was created.
modified_by
object
This field describes by whom last modification was done.

List Calendars

Retrieves all available list of calendars.

GET /v1/calendars

Example Request

curl -v \
"https://app.eresourcescheduler.cloud/rest/v1/calendars" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV"

Exmaple Response

{
  "total_count": 4,
  "data": [{
      "id": 2,
      "name": "New York Calendar",
      "description": null,
      "is_default": false,
      "timings": [{
        "day_num": 1,
        "start_time": 540,
        "end_time": 1020
      }, {
        "day_num": 2,
        "start_time": 540,
        "end_time": 1020
      }, {
        "day_num": 3,
        "start_time": 540,
        "end_time": 1020
      }, {
        "day_num": 4,
        "start_time": 540,
        "end_time": 1020
      }, {
        "day_num": 5,
        "start_time": 540,
        "end_time": 1020
      }],
      "holidays": [{
        "id": 1,
        "name": "Christmas Day",
        "description": null,
        "date": "2018-12-25",
        "tags": []
      }],
      "exceptions": [{
        "id": 1,
        "name": "Over Time",
        "description": null,
        "date": "2018-12-20",
        "is_working_exception": true,
        "tags": [],
        "timings": [{
          "start_time": 540,
          "end_time": 1140
        }]
      }],
      "created_on": "2018-08-21T10:03:08.650207+00:00",
      "modified_on": "2018-12-03T15:09:34.697541+00:00",
      "created_by": {
        "id": 118,
        "name": "John Doe"
      },
      "modified_by": {
        "id": 118,
        "name": "John doe"
      }
    },
    { ... },
    { ... },
    { ... }
  ]
}

Returns

Code Description
200
OK
Indicates that the operation was successful and list of calendars is returned.

Retrieve a calendar

Retrieves the specified calendar along with exceptions and holidays applied on it.

GET /v1/calendars/{ID}

Example Request

curl -v \
"https://app.eresourcescheduler.cloud/rest/v1/calendars/1" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV"

Example Response

{
    "id": 2,
    "name": "New York Calendar",
    "description": null,
    "is_default": false,    
    "timings": [{
        "day_num": 1,
        "start_time": 540,
        "end_time": 1020
    }, {
        "day_num": 2,
        "start_time": 540,
        "end_time": 1020
    }, {
        "day_num": 3,
        "start_time": 540,
        "end_time": 1020
    }, {
        "day_num": 4,
        "start_time": 540,
        "end_time": 1020
    }, {
        "day_num": 5,
        "start_time": 540,
        "end_time": 1020
    }],
    "holidays": [{
        "id": 1,
        "name": "Christmas Day",
        "description": null,
        "date": "2018-12-25",
        "tags": []
    }],
    "exceptions": [{
        "id": 1,
        "name": "Over Time",
        "description": null,
        "date": "2018-12-20",
        "is_working_exception": true,
        "tags": [],
        "timings": [{
            "start_time": 540,
            "end_time": 1140
        }]
    }],
    "created_on": "2018-08-21T10:03:08.650207+00:00",
    "modified_on": "2018-12-03T15:09:34.697541+00:00",
    "created_by": {
        "id": 118,
        "name": "John Doe"
    },
    "modified_by": {
        "id": 118,
        "name": "John doe"
    }
}

Returns

Code Description
200
OK
Indicates that the operation was successful and requested calendar is returned.
404
Not Found
indicates that calendar object with specified calendar_id does not exist.

Resource

Resource object

Example Response

{
    "id": 1,
    "first_name": "Andrew",
    "last_name": "Mooney",
    "name": "Andrew Mooney",
    "type": {
        "name": "Employee",
        "description": null,
        "id": 1,
        "is_human": true
    },
    "email": "andrew@enbraun.com",
    "start_date": "2018-01-01",
    "last_date": null,
    "image": "https://erscloud/img/7aca31f5-29ae205ba315",
    "phone": null,
    "roles": [{
        "name": "Quality Engineer",
        "description": null,
        "id": 3
    }, {
        "name": "Business Analyst",
        "description": null,
        "id": 1
    }],
    "tags": [],
    "created_on": "2018-08-20T09:22:02.728296Z",
    "created_by": {
        "name": "Rahul Sharma",
        "id": 118
    },
    "modified_on": "2018-11-20T11:55:48.880898Z",
    "modified_by": {
        "name": "Rahul Sharma",
        "id": 118
    },
    "udf_qualifications": [{
        "name": "B.Tech Computers",
        "description": null,
        "id": 15
    }, {
        "name": "PMP",
        "description": null,
        "id": 13
    }],
    "udf_employee_no": "ABC0001",
    "udf_office": {
        "name": "New York",
        "description": null,
        "id": 10
    },
    "udf_department": {
        "name": "Technical",
        "description": null,
        "id": 26
    }
}

Resource object represent resources (human / non-human) in your organization (i.e. Employees , Machines etc. ) which you want to schedule. Resources could be of multiple types with each type having its own custom attributes along with system defined attributes. The API allows you to list, search, create, delete, and update resources.

ATTRIBUTES

Name Description
id
integer
Auto generated unique identifier for resource object.
first_name
string
First name of resource.
last_name
string
Last name of resource.
type
object
Describes the type of resource. This is one of the type objects which an admin user creates using eRS Cloud Application.
email
string
Email address of resource object.
start_date
string
Represents the first working day of resource in organization. Resource does not have any availability before this date.
last_date
string
Represents the last working day of resource in organization. After this date, resource is considered archived and has no availability beyond this date.
image
string
String value representing URL of image file of resource.
phone
string
Phone number of the resource object.
roles
array of objects
List of role objects applied on this resource.
tags
array of strings
Tags are the list of strings (labels) attached to this resource object which could be used for the purpose of filtering, identification or other information.
created_on
string
Timestamp at which this resource object was created.
created_by
object
Object representing user who created this resource object.
modified_on
string
Represents latest modification timestamp.
modified_by
object
Object representing most recent user who modified this resource object.
udf_* Custom user-defined fields used to capture additional information of resource. User defined field can be of multiple types. Custom fields are very useful to configure resource objects to best fit requirements. In given example response, all keys starting with prefix udf_ are user defined custom fields. Learn more

Create a resource

Creates a new resource object.

POST /v1/resources

Example Request for human type of resource:

 curl -v -X POST "https://app.eresourcescheduler.cloud/rest/v1/resources" \
 -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
 -H "Content-Type: application/json" \
 -d '{ 
       "first_name": "Andrew",
       "last_name": "Mooney",
       "resource_type_id": 1,
       "start_date": "2016-05-02",
       "email": "andrew@enbraun.com",
       "roles" : [1,3],
       "udf_employee_no": "ABC0001"
     }'

Example Request for non-human resource:

 curl -v -X POST "https://app.eresourcescheduler.cloud/rest/v1/resources" \
 -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
 -H "Content-Type: application/json" \
 -d '{  
       "name": "Projector EX4300",
       "start_date": "2018-06-01",
       "resource_type_id": 2,
       "udf_battery_capacity": 4 
     }'

REQUEST BODY PARAMETERS

Name Description
resource_type_id
required
Id of resource-type object. Every resource must be linked to a resource-type. Let’s assume there are two resource types defined as Employee (having id 1) and Meeting Room (having id 2). While creating a new resource, all the resource whose resource_type_id is given as 1 will get created under Employee type and same for Meeting Room when resource_type_id is 2.
first_name
required
String representing the first name of a resource. This may be up to 100 characters.
Note : for non-human resources, this field is not available.
last_name
optional
String representing the last name of a resource. This may be up to 100 characters.
Note : for non-human resources, this field is not available.
name
required
String representing the name of a resource. This may be up to 100 characters.
Note : This field is only available for non-human resources and for human resources, this is not available.
start_date
required
String value representing a date in ISO 8601 extended notation for date i.e. yyyy-MM-dd. A resource is only available from its start date i.e system does not consider any capacity of resource before this date.
last_date
optional
String value representing a date in ISO 8601 extended notation for date i.e. yyyy-MM-dd. A resource is only available till its last date i.e system does not consider any capacity of resource beyond this date (if defined).
email
optional
String value representing email address of resource object. Email address must be properly formatted with a maximum length of 254 characters.
phone
optional
String representing phone number of resource. It’s displayed alongside the resource in your resource list.
roles
optional
An array of ids of Roles (which are defined by an admin user in eRS Cloud Application) to be assigned to this Resource. The first id in the array is considered as Primary Role of that Resource. Multiple performing roles can be applied to a resource. Resources can also be searched / filtered using performing roles.
calendar
optional
Id of Calendar object which should be assigned to resource effective from its start date. Depending upon requirements, different calendars can be applied on different resources. If calendar is omitted then default calendar (as defined in admin settings) will get applied for this resource.
tags
optional
An optional array of strings which could be attached to this resource object as labels. This can be useful for the purpose of filtering, identification or other information.
udf_*
optional
A user with admin rights can add custom fields. These fields can be used to capture additional information in Resources. Different types of resources may have a different set of user-defined fields. The value for user defined field can be passed as shown in example request. In first example udf_employee_no is a user defined field. Learn more

Returns

Code Description
201
Created
Indicates that the operation was successful and a resource get created successfully.
400
Bad Request
Bad Request error occurs when a request is malformed, syntactically incorrect, missing required parameters or has any unknown parameter. Additionally, Bad request may also occur in one of these conditions :
  • Resource's start date is after its end date.
  • Trying to create resources more than subscribed no of resources.
403
Forbidden
Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.

List resources

Returns a list of resources. The resources are returned sorted by name.

GET /v1/resources

Example Request

curl -v \
"https://app.eresourcescheduler.cloud/rest/v1/resources" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV"

Example Request With Offset And Limit

curl -v \
"https://app.eresourcescheduler.cloud/rest/v1/resources?offset=1&limit=15" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV"

Example Response

{
  "total_count": 120,
  "offset": 1,
  "limit": 15,
  "data": [{
      "id": 1,
      "first_name": "Andrew",
      "last_name": "Mooney",
      "name": "Andrew Mooney",
      "type": {
        "name": "Employee",
        "description": null,
        "id": 1,
        "is_human": true
      },
      "email": "andrew@enbraun.com",
      "start_date": "2018-01-01",
      "last_date": null,
      "image": "https://erscloud/img/7aca31f5-29ae205ba315",
      "phone": null,
      "roles": [{
        "name": "Quality Engineer",
        "description": null,
        "id": 3
      }, {
        "name": "Business Analyst",
        "description": null,
        "id": 1
      }],
      "tags": [],
      "created_on": "2018-08-20T09:22:02.728296Z",
      "created_by": {
        "name": "Rahul Sharma",
        "id": 118
      },
      "modified_on": "2018-11-20T11:55:48.880898Z",
      "modified_by": {
        "name": "Rahul Sharma",
        "id": 118
      },
      "udf_qualifications": [{
        "name": "B.Tech Computers",
        "description": null,
        "id": 15
      }, {
        "name": "PMP",
        "description": null,
        "id": 13
      }],
      "udf_employee_no": "ABC0001",
      "udf_office": {
        "name": "New York",
        "description": null,
        "id": 10
      },
      "udf_department": {
        "name": "Technical",
        "description": null,
        "id": 26
      }
    },
    { ... },
    { ... },
    { ... }
  ]
}

REQUEST QUERY PARAMETERS

Name Description
limit
optional
The limit keyword is used to limit the number of records returned from a result set. If a limit count is given, no more than that many records will be returned (but possibly less, if the query itself yields less records)
Default value of limit is 25
Maximum value of limit can be 500
offset
optional
Offset keyword is used to skip n items. If offset value is given as 10, then first 10 records will be skipped from result set. Offset is often used together with the Limit keyword.
Default value of offset is 0

Returns

Code Description
200
OK
Indicates that the operation was successful and list of resources is returned.
400
Bad Request
Bad Request may occur when offset and limit value is negative integer.
403
Forbidden
Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.

Retrieve a resource

GET /v1/resources/{ID}

Example Request

curl -v "https://app.eresourcescheduler.cloud/rest/v1/resources/1" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV"

Example Response

{
    "id": 1,
    "first_name": "Andrew",
    "last_name": "Mooney",
    "name": "Andrew Mooney",
    "type": {
        "name": "Employee",
        "description": null,
        "id": 1,
        "is_human": true
    },
    "email": "andrew@enbraun.com",
    "start_date": "2018-01-01",
    "last_date": null,
    "image": "https://erscloud/img/7aca31f5-29ae205ba315",
    "phone": null,
    "roles": [{
        "name": "Quality Engineer",
        "description": null,
        "id": 3
    }, {
        "name": "Business Analyst",
        "description": null,
        "id": 1
    }],
    "tags": [],
    "created_on": "2018-08-20T09:22:02.728296Z",
    "created_by": {
        "name": "Rahul Sharma",
        "id": 118
    },
    "modified_on": "2018-11-20T11:55:48.880898Z",
    "modified_by": {
        "name": "Rahul Sharma",
        "id": 118
    },
    "udf_qualifications": [{
        "name": "B.Tech Computers",
        "description": null,
        "id": 15
    }, {
        "name": "PMP",
        "description": null,
        "id": 13
    }],
    "udf_employee_no": "ABC0001",
    "udf_office": {
        "name": "New York",
        "description": null,
        "id": 10
    },
    "udf_department": {
        "name": "Technical",
        "description": null,
        "id": 26
    }
}

Retrieves the details of an existing resource. You only need to provide the unique resource identifier that was returned upon resource creation as request parameter .

Returns

Code Description
200
OK
Indicates that the operation was successful and a resource is retrieved successfully .
403
Forbidden
Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
404
Not Found
Not Found error occurs when requested resource does not exist (i.e. There is no resource with given id). This may also occur when requesting a resource which has been deleted.

Search resources

POST /v1/resources/search

Example Request For Filter In JSON Format

curl -X POST \
"https://app.eresourcescheduler.cloud/rest/v1/resources/search" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
-d '{ 
      "resource_type_id:eq": 1  
    }'

Example Request For Filter By Passing Multiple Rules In JSON Format

curl -X POST \
"https://app.eresourcescheduler.cloud/rest/v1/resources/search" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
-d '{ 
      "resource_type_id:eq": 1 , 
      "roles:all": [3,6] 
    }'

Search Resource API allows filtering the results returned in various ways. This enables a great power to find out what is needed. eRS Cloud API also allows filtering on custom defined fields with multiple operators and conditions to cover up complex scenarios for searching.

A filter condition consists of three components which are field, operator and value. For example, fetching only those resources having resource type id 1, could be achieved by adding resource_type_id:eq=1 to your query. If operator is not supplied, it takes default operator for field.

Below is a list of available fields, which allow filtering resources:

Field Code Operator Example
resource_type_id
  • eq (default)
  • any
  • "resource_type_id:eq": 1
    "resource_type_id:any": [1,2]
    name
  • has (default)  
  • eq
  • "name:has": "c"
    "name:eq": "Amy Jones"
    roles
  • any (default)
  • all
  • "roles:any": [2,5]
    "roles:all": [4,6]
    tags
  • any (default)
  • all
  • "tags:any": ["tagA","tagB"]
    "tags:all": ["tagA","tagB"]
    email
  • has (default)
  • eq
  • "email:has": "a"
    "email:eq": "abc@mycompany.com"
    phone
  • has (default)
  • eq
  • "phone:has": "753"
    "phone:eq": "(485)555-0202"
    start_Date
  • eq (default)
  • lt
  • gt
  • bt
  • ex
  • "start_date:eq": "2016-01-27"
    "start_date:lt": "1999-12-22"
    "start_date:gt": "1990-01-11"
    "start_date:bt": ["2001-01-01", "2010-12-31"]
    "start_date:ex": ["1992-02-12", "1997-01-27"]
    last_date
  • eq (default)
  • lt
  • gt
  • bt
  • ex
  • "last_date:eq": "2016-05-17"
    "last_date:lt": "2002-12-31"
    "last_date:gt": "2010-01-01"
    "last_date:bt": ["1995-12-31", "1999-01-01"]
    "last_date:ex": ["2001-01-01", "2002-01-01"]

    For filtering using custom fields and operators please check here.

    Update a resource

    Updates specified resource by setting the values of the parameters passed. Any parameter which is not provided remains unchanged. To unset existing value for a parameter, just pass an empty value i.e. null or undefined.

    This request accepts mostly the same arguments as Create Resource API.

    PUT /v1/resources/{ID}

    Example Request

    curl -v -X PUT \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/1" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
    -H "Content-Type: application/json" \
    -d '{ 
          "email": "andrew@enbraun.com",
          "roles" : [3,2],
          "udf_employee_no": "ABC0003"
        }'
    

    REQUEST BODY PARAMETERS

    Name Description
    first_name
    required
    String representing the first name of a resource. This may be up to 100 characters.
    Note : for non-human resources, this field is not available.
    last_name
    optional
    String representing the last name of a resource. This may be up to 100 characters.
    Note : for non-human resources, this field is not available.
    name
    required
    String representing the name of a resource. This may be up to 100 characters.
    Note : This field is only available for non-human resources and for human resources, this is not available.
    start_date
    required
    String value representing a date in ISO 8601 extended notation for date i.e. yyyy-MM-dd. A resource is only available from its start date i.e system does not consider any capacity of resource before this date.
    last_date
    optional
    String value representing a date in ISO 8601 extended notation for date i.e. yyyy-MM-dd. A resource is only available till its last date i.e system does not consider any capacity of resource beyond this date (if defined).
    email
    optional
    String value representing email address of resource object. Email address must be properly formatted with a maximum length of 254 characters.
    phone
    optional
    String representing phone number of resource. It’s displayed alongside the resource in your resource list.
    roles
    optional
    An array of ids of Roles (which are defined by an admin user in eRS Cloud Application) to be assigned to this Resource. The first id in the array is considered as Primary Role of that Resource. Multiple performing roles can be applied to a resource. Resources can also be searched / filtered using performing roles.
    tags
    optional
    An optional array of strings which could be attached to this resource object as labels. This can be useful for the purpose of filtering, identification or other information.
    udf_*
    optional
    A user with admin rights can add custom fields. These fields can be used to capture additional information in Resources. Different types of resources may have a different set of user-defined fields. The value for user defined field can be passed as shown in example request. In first example udf_employee_no is a user defined field. Learn more

    Returns

    Code Description
    200
    OK
    Indicates that the operation was successful and requested resource is successfully updated.
    400
    Bad Request
    Bad Request occurs when a request is not well-formed, syntactically incorrect, empty required parameters or any unknown parameter is passed.
    Additionally, Bad request may also occur in one of these conditions :
  • Trying to update an archived resource.
  • Trying to change start_date or last_date such that last_date gets smaller than start_date.
  • Trying to update start date and last date of a resource such that existing booking of that resource do not fit in given range.
  • 403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested resource does not exist (i.e. There is no resource with given id). This may also occur when updating a resource which has been deleted.

    Delete a resource

    Permanently deletes requested resource. It cannot be undone. By default, this operation will get failed if a resource has any booking associated with it. To override this, forceful delete can be used which will delete all bookings and then ultimately delete the resource object.

    DELETE /v1/resources/{ID}

    Example Request

    curl -v -X DELETE \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/1" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Request For Forceful Delete

    curl -v -X DELETE \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/1/?\
    force_delete_bookings=true" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV" 
    

    Returns

    Code Description
    200
    OK
    This status code indicates that the operation was successful and a resource get deleted successfully.
    409
    Conflict
    Conflict indicates that the resource can not be deleted as there are bookings associated with this resource. If you wish to anyway delete it, you must use force delete option by passing true for parameter force_delete_bookings. This operation deletes all bookings of requested resource and resource itself (shown in example request).
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested resource does not exist.

    Timings

    Example Response

      {
             "id": 5,
             "name": "Part Time",
             "effective_date": "2018-11-15",
             "applied_on": "2018-11-03T15:06:15.454+05:30",
             "created_on": "2018-11-03T15:06:15.484913+05:30",
             "modified_on": null,
             "created_by": {
                "id": 2,
                "name": "Patrick Wilson"
             },
             "modified_by": {
                "id": null,
                "name": null
             },
             "timings": [
                {
                   "day_num": 2,
                   "start_time": 600,
                   "end_time": 840
                }
              ] 
    
      }
    

    To capture timings about a resource, eRS Cloud provides Timings. One resource may work in different timings as per his availability or requirement, for such situations Timings are beneficial.

    Let say, If a resource works on a full-time profile but then for a certain time of period he switched his timings from full-time to part-time. Then for that certain period “Part Time” calendar will get applied along with its effective date. Timings are beneficial to apply multiple calendars on a resource.

    eRS Cloud API allows you to perform POST, GET, PUT, DELETE operations on Notes.

    ATTRIBUTES

    Name Description
    id
    integer
    eRS Cloud-generated unique identifier for the calendar object.
    name
    string
    This field describes name of calendar object.
    effective_date
    string
    Effective date is the date on which the calendar will come into effect on applied resources.
    applied_on
    string
    This field describes when calendar is applied.
    created_on
    string
    Time at which the calendar object is created.
    created_by
    object
    This field describes by whom calendar object is created.
    modified_on
    string
    Describes the latest modification date.
    modified_by
    object
    This field describes by whom the modification is done.
    timings
    array of strings
    Timings are list of days in which day_num is defined day(For example-0 for sunday,1 for monday) and start time and end time are defined start time and end time for a particular day respectively, also we can calculate no of working-hours on that day.

    Retrieving the timings

    GET v1/resources/{ID}/timings

    Example Request

    curl -v -X GET "https://app.eresourcescheduler.cloud/rest/v1/resources/12/timings"\
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Response

    {
       "total_count": 2,
       "data": [
          {
             "id": 5,
             "name": "Part Time",
             "effective_date": "2018-11-15",
             "applied_on": "2018-11-03T15:06:15.454+05:30",
             "created_on": "2018-11-03T15:06:15.484913+05:30",
             "modified_on": null,
             "created_by": {
                "id": 2,
                "name": "Patrick Wilson"
             },
             "modified_by": {
                "id": null,
                "name": null
             },
             "timings": [
                {
                   "day_num": 2,
                   "start_time": 600,
                   "end_time": 840
                },
                {...},
                {...},              
              ]
          },
          {...},
          {...} 
       ]
    }
    

    Retrieves the details of timings which are applied to the resource. You only need to provide the unique resource identifier that was returned upon resource creation.

    Returns

    Code Description
    200
    OK
    This status code indicates that the operation was successful and timings get retrieved successfully .
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested resource does not exist (i.e. There is no resource with given id). This may also occur when requesting a resource which has been deleted.

















    Applying new timing (POST)

    POST v1/resources/{ID}/timings

    Example Request

    curl -v -X POST "https://app.eresourcescheduler.cloud/rest/v1/resources/12/timings" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
      -H "Content-Type: application/json" \
      -d '{ 
            "applied_on": "2018-12-04T08:14:41.109Z", 
            "calendar_id": "5", 
            "effective_date": "2018-02-02" 
          }'
    

    REQUEST BODY PARAMETERS

    Name Description
    applied_on
    required
    Applied_on Field describes when calendar is applied. It is a DateTime type of field.
    calendar_id
    required
    As the name shows it is a calendar id which we have to pass. You will get this id at the time of calendar creation. This field accepts Integer only.
    effective_date
    required
    Effective date is the date on which the calendar will come into effect on applied resources. This field accepts Date only.

    Returns

    Code Description
    201
    Created
    This status code indicates that the operation was successful and timing get applied successfully.
    400
    Bad Request
    Bad Request error occurs when a request is malformed, syntactically incorrect, missing required parameters are or any unknown parameter is passed.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested resource does not exist.

    Update timings

    PUT v1/resources/{ID}/timings/{Timing_ID}

    Example Request

    curl -v -PUT "https://app.eresourcescheduler.cloud/rest/v1/resources/12/timings/2" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
      -H "Content-Type: application/json" \
      -d '{ 
            "applied_on": "2018-12-04T08:14:41.109Z", 
            "calendar_id": "5", 
            "effective_date": "2018-02-02" 
          }' 
    

    Updates the specified resource's calendar by setting the value of the parameter passed. You need to provide the unique resource identifier that was returned upon resource creation and unique timing identifier that was returend upon timing addition. If parameter is not provided then it will be left unchanged.

    This request accepts mostly the same argument as the note creation call.

    REQUEST BODY PARAMETERS

    Name Description
    applied_on
    required
    Applied_on Field describes when calendar is applied. It is a DateTime type of field.
    calendar_id
    required
    As the name shows it is a calendar id which we have to pass. You will get this id at the time of calendar creation. This field accepts Integer only.
    effective_date
    required
    Effective date is the date on which the calendar will come into effect on applied resources. This field accepts Dateonly.

    Returns

    Code Description
    200
    OK
    This indicates that the operation was successful and a timing get updated successfully.
    400
    Bad Request
    Bad Request occurs when a request is not well-formed, syntactically incorrect, empty required parameters or any unknown parameter is passed.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested resource id or timing id does not exist.

    Delete timings

    DELETE v1/resources/{ID}/timings/{Timing_ID}

    Permanently deletes a applied Calendar. It cannot be undone. You need to provide the unique resource identifier that was returned upon resource creation and unique timing identifier that was returend upon timing addition.

    Example Request

    curl -v -X DELETE \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/12/timings/2" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Returns

    Code Description
    200
    OK
    This status code indicates that the operation was successful and a applied calendar get deleted successfully
    404
    Not Found
    Not Found error occurs when requested resource id or timing id does not exist.

    Exceptions

    Example Response

    {
       "total_count":1,
       "data":[
          {
             "id":2,
             "name":"Working Sunday",
             "description":"Working Sunday",
             "date":"2018-11-17",
             "is_working_exception":true,
             "created_on":"2018-11-03T15:07:30.917087+05:30",
             "modified_on":null,
             "created_by":{
                "id":2,
                "name":"Patrick Wilson"
             },
             "modified_by":{
                "id":null,
                "name":null
             },
             "timings":[
                {
                   "start_time":600,
                   "end_time":1080
                }
             ]
          }
       ]
    }
    

    Exception is nothing but timing-duration that is different from a general schedule. eRS provides you the feature to add an exception to a resource.

    Let's say, a resource having calendar which does not have Sunday working. But for some reason, resource has to work on Sunday then this a case of exception. So in such situation exception comes handy.

    eRS Cloud provides you two types of exceptions:

    1. Working Exception :

            Working Exception is get added on a non-working day.

    2. Non-working Exception :

            Non-working Exception is get added on a working day.

    Working Exception can be added without timings

    ATTRIBUTES

    Name Description
    id
    integer
    eRS Cloud-generated unique identifier for the exceptions object.
    name
    string
    This field describes name of exception.
    description
    string
    This field describes about the exception.
    date
    string
    Date Field describes when will exception get applied.
    is_working_exception
    boolean
    Is working exception describes whether exception is a working exception or non working exception. True value means that exception is working exception and false value means that exception is non working exception.
    created_on
    string
    Time at which exception is created.
    modified_on
    string
    Describes the latest modification date.
    created_by
    object
    This field describes by whom exception is created .
    modified_by
    object
    This field describes by whom the modification is done.
    timings
    object
    Timings describes the timings of exception.

    Retrieving exceptions

    GET v1/resources/{ID}/exceptions

    Example Request

    curl -v -X GET \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/12/exceptions" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Retrieves the details of exceptions which are applied to the resource. You only need to provide the unique resource identifier that was returned upon resource creation.

    Returns

    Code Description
    200
    OK
    This status code indicates that the operation was successful and exceptions get retrieved successfully .
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested resource does not exist (i.e. There is no resource with given id). This may also occur when requesting a resource which has been deleted.

    Create an exception

    POST v1/resources/{ID}/exceptions

    Example Request

    curl -v -X POST \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/12/exceptions" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
      -H "Content-Type: application/json" \
      -d '{ 
            "date": "2018-11-02", 
            "description": "Thursday 1", 
            "name": "Thursday 1", 
              "is_working_exception": true, 
              "timing_blocks":[ 
                      { 
                        "start_time":600, 
                        "end_time":1080 
                      } 
                   ]  
           }'
    

    REQUEST BODY PARAMETERS

    Name Description
    date
    required
    Date Field describes when will exception get applied. It is a Date type of field.
    descirption
    optional
    As the name shows it is a description which we want to give for the exception . This field is a string type of field.
    name
    required
    Name describes the name of exception. This field is a string type of field
    is_working_exception
    required
    Is working exception describes whether exception is a working exception or not. Accepts true if it is a working exception otherwise accepts false if it a non-working exception. This field is a boolean type of field
    timing_blocks
    optional
    Timing_blocks describes the timings of exception. This filed can be passed null, as eRS Cloud provids you the facility to create an exception without timings. This field is a Array of objects type of field
    timings.start_time
    optional
    Start time describes the start time of exception. This filed can be passed null, as eRS Cloud provids you the facility to create an exception without timings. This field is a Integer type of field.
    timings.end_time
    optional
    End time describes the end time of exception. This filed can be passed null, as eRS Cloud provids you the facility to create an exception without timings. This field is a Integer type of field.

    Returns

    Code Description
    201
    Created
    This status code indicates that the operation was successful and exception get created successfully.
    400
    Bad Request
    Bad Request error occurs when a request is malformed, syntactically incorrect, missing required parameters are or any unknown parameter is passed.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that resource does not exist

    Update an exception

    PUT v1/resources/{ID}/exceptions/{Exception_ID}

    Example Request

    curl -v -PUT \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/12/exceptions/2" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
      -H "Content-Type: application/json" \
      -d '{ 
        "date": "2018-11-02", 
        "description": "Thursday 1", 
        "name": "Thursday 1", 
        "is_working_exception": true, 
        "timing_blocks":[ 
                { 
                   "start_time":600, 
                   "end_time":1080 
                } 
             ]  
        }'
    

    Updates the specified resource's exception by setting the value of the parameter passed. You need to provide the unique resource identifier that was returned upon resource creation and unique exception identifier that was returend upon exception addition. If parameter is not provided then it will be left unchanged.

    This request accepts mostly the same argument as the exception creation call.

    REQUEST BODY PARAMETERS

    Name Description
    date
    required
    Date Field describes when will exceptiob get applied. It is a Date type of field.
    descirption
    optional
    As the name shows it is a description which we want to give for the exception . This field is a string type of field.
    name
    required
    Name describes the name of exception. This field is a string type of field
    is_working_exception
    required
    Is working exception describes whether exception is working exception or not. Accepts true if it is working exception otherwise accepts false if it a non-working exception. This field is a boolean type of field
    timing_blocks
    optional
    Timing_blocks describes the timings of exception. This filed can be pass null, as eRS Cloud provids you the facility to create an exception without timings. This field is a Array of objects type of field
    timings.start_time
    optional
    Start time describes the start time of exception. This filed can be pass null, as eRS Cloud provids you the facility to create an exception without timings. This field is a Integer type of field.
    timings.end_time
    optional
    End time describes the end time of exception. This filed can be pass null, as eRS Cloud provids you the facility to create an exception without timings. This field is a Integer type of field.

    Returns

    Code Description
    200
    OK
    This indicates that the operation was successful and a exception get updated successfully.
    400
    Bad Request
    Bad Request occurs when a request is not well-formed, syntactically incorrect, empty required parameters or any unknown parameter is passed.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that resource or exception does not exist

    Delete an exception

    DELETE v1/resources/{ID}/exceptions/{Exception_ID}

    Permanently deletes a applied exception. It cannot be undone. You need to provide the unique resource identifier that was returned upon resource creation and unique exception identifier that was returend upon exception addition.

    Example Request

    curl -v -X DELETE \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/12/exceptions/2"\
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    
    Code Description
    200
    OK
    This status code indicates that the operation was successful and exception get deleted successfully
    404
    Not Found
    This status code indicates that resource or exception does not exist

    Notes

    Exmaple Response

    {
       "total_count":3,
       "limit":25,
       "offset":0,
       "data":[
          {
             "id":8,
             "created_on":"2018-09-02T17:41:14.642026+05:30",
             "content":"<p>Awarded by  &#34;Employee Of The Month&#34; 
                        award on Aug  09, 2017<br> </p>",
             "modified_on":null,
             "created_by":{
                "id":2,
                "name":"Patrick Wilson"
             },
             "modified_by":{
                "id":null,
                "name":null
             }
          },
          {...},
          {...}
       ]
    }
    

    To capture additional information about a resource, eRS Cloud provides the Notes. If one has to provide any new information to a resource which is not captured from the filed, for such situations Notes are beneficial.

    Let's say, If a resource has role "A", but after a certain time his role get changed or new role gets added to his profile. Roles field gives us the ability to add, update or delete a role. But it does not give brief information when the role get added, deleted or updated. The Notes comes in handy in such situations. Notes are handy to maintain the history of a resource.

    eRS Cloud API allows you to perform POST, GET, PUT, DELETE operations on Notes.

    The Notes Of Archived Resource remain available for the records.

    ATTRIBUTES

    Name Description
    id
    integer
    eRS Cloud generated unique identifier for the notes.
    content
    string
    Text written inside notes body .
    created_on
    string
    Time at which the notes object is created.
    modified_on
    string
    Describes the latest modification date.
    created_by
    object
    This field describes by whom notes is created .
    modified_by
    object
    This field describes by whom the modification is done .

    List notes

    GET v1/resources/{ID}/notes

    Retrieves the Notes list of specified resource. You need to provide the unique resource identifier that was returned upon resource creation.The notes are returned which sorted by lastly modified or added.

    Example Request

    curl -v -X GET \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/8/notes" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Request With Offset And Limit

    curl -v -X GET \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/8/notes?offset=1&limit=1" \
     -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Request With orderBy

    curl -v -X GET \
     "https://app.eresourcescheduler.cloud/rest/v1/resources/8/notes?offset=1&limit=1&order_by=created_on" \
     -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    REQUEST QUERY PARAMETERS

    Name Description
    limit
    optional
    The limit keyword is used to limit the number of notes returned from a result set.
    The default value of limit is 25
    Maximum value of limit can be 100. If Limit value is exceeds than100 then it will set to 100 which is Maximum value for limit.
    offset
    optional
    The Offset value allows specifying which note to start from retrieving data.The Offset value is also most often used together with the Limit keyword.
    The default value of offset is 0

    Ordering the notes

    REQUEST QUERY PARAMETERS

    Name Options Description
    Order_by
    optional
  • created_on (Default)
  • List of notes will be returned and sorted by it's created date.
  • modified_on
  • List of notes will be returned and sorted by it's latest modified date

    Returns

    Code Description
    200
    OK
    This indicates that the operation was successful and a list of notes is returned.
    400
    Bad Request
    Bad Request may occur when offset and limit value is given as negative integer.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that resource does not exist

    Example Request

    Create a note

    POST v1/resources/{ID}/notes

    Example Request

    
    curl -v -X POST \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/8/notes"\
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"\
      -H "Content-Type: application/json"\
      -d '{"content": "Hello Enbraun"}'
    

    Example Request With HTML Tag

    
    curl -v -X POST \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/8/notes" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
      -H "Content-Type: application/json" \
      -d '{"content": "<p>Hello Enbraun</p>"}'
    

    REQUEST BODY PARAMETERS

    Name Description
    content
    required
    To create new note you have to pass the body from content parameter. Content param accepts plain text. Also, you can pass text with HTML tags as Notes are Multi Line Rich Text.

    Returns

    Code Description
    201
    Created
    This status code indicates that the operation was successful and created a note successfully.
    400
    Bad Request
    Bad Request error occurs when a request is malformed, syntactically incorrect, missing required parameters are or any unknown parameter is passed.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that resource does not exist

    Update a note

    PUT v1/resources/{ID}/notes/{Note_ID}

    Updates the specified resource's note by setting the value of the parameter passed. You need to provide the unique resource identifier that was returned upon resource creation and unique note identifier that was returend upon notes creation. If parameter is not provided then it will be left unchanged.

    This request accepts mostly the same argument as the note creation call.

    Example Request

    
    curl -v -X PUT \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/8/notes/4" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
      -H "Content-Type: application/json" \
      -d '{"content": "Hello World"}'
    

    Example Request With HTML Tags.

    
    curl -v -X PUT \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/8/notes/4" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"\
      -H "Content-Type: application/json" \
      -d '{"content": "<p>Hello World</p>"}' 
    

    REQUEST BODY PARAMETERS

    Name Description
    content
    required
    To update note you have to pass the body from content parameter. Content param accepts plain text. Also, you can pass text with HTML tags as Notes are Multi Line Rich Text.

    Returns

    Code Description
    200
    OK
    This indicates that the operation was successful and a note get updated successfully.
    400
    Bad Request
    Bad Request occurs when a request is not well-formed, syntactically incorrect, empty required parameters or any unknown parameter is passed.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that resource or notes does not exist

    Delete a note

    DELETE v1/resources/{ID}/notes/{Note_ID}

    Permanently deletes a Note. It cannot be undone.You need to provide the unique resource identifier that was returned upon resource creation and unique note identifier that was returend upon notes creation.

    Example Request

    
    curl -v -X DELETE \
    "https://app.eresourcescheduler.cloud/rest/v1/resources/8/notes/5" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    
    Code Description
    200
    OK
    This status code indicates that the operation was successful and a note get deleted successfully
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that resource or notes does not exist

    Project

    Project object

    Example Response

      {
        "id": 1,
        "title": "Project-A",
        "type": {
          "name": "Satellite",
          "description": null,
          "id": 1
        },
        "email": "apollo@enbraun.com",
        "project_start_date": null,
        "end_date": null,
        "image": "https://erscloud/img/7aca31f5-29ae205ba315",
        "tags": ["NASA"],
        "is_archive": false,
        "created_on": "2018-08-20T09:25:34.925474Z",
        "created_by": {
          "name": "Rahul Sharma",
          "id": 118
        },
        "modified_on": "2018-09-28T12:32:44.896426Z",
        "modified_by": {
          "name": "Rahul Sharma",
          "id": 118
        },
        "udf_color": "#FF8A80;0",
        "udf_progress": 70,
        "udf_project_manager": "Gene Kranz",
        "udf_priority": {
          "name": "High",
          "description": null,
          "id": 21
        }
      }
    

    Project object contains all the information about a project. Project is used as an activity for resources to be scheduled for. The API allows you to list, search, create, delete, and update project.

    ATTRIBUTES

    Name Description
    id
    integer
    eRS Cloud-generated unique identifier for the project object.
    title
    string
    Represents title or name of the project.
    type
    object
    Describes the type of project. This is one of the project type objects which an admin user creates using eRS Cloud Application.
    email
    string
    An optional email address of project object.
    project_start_date
    string
    Date on which project is considered started.
    end_date
    string
    Date on which project is considered ended / completed.
    image
    string
    String value representing URL of image file of project.
    tags
    array of strings
    Tags are the list of strings (labels) attached to this project object which could be used for the purpose of filtering, identification or other information.
    is_archive
    boolean
    Boolean value representing whether this project is archived or not.
    created_on
    string
    Timestamp at which this project object was created.
    created_by
    object
    Object representing user who created this project object.
    modified_on
    string
    Represents latest modification timestamp.
    modified_by
    object
    Object representing most recent user who modified this project object.
    udf_* Custom user-defined fields used to capture additional information of project. User defined field can be of multiple types. Custom fields are very useful to configure project objects to best fit requirements. In given example response, all keys starting with prefix udf_ are user defined custom fields. Learn more

    Create a project

    Creates a new project object.

    POST /v1/projects

    Example Request:

     curl -v -X POST "https://app.eresourcescheduler.cloud/rest/v1/projects" \
     -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
     -H "Content-Type: application/json" \
     -d '{ 
           "title": "Project-A",
           "project_type_id": 1,
           "project_start_date": "2016-05-02",
           "email": "andrew@enbraun.com",
           "udf_progress": 70
         }'
    

    REQUEST BODY PARAMETERS

    Name Description
    project_type_id
    required
    Id of project-type object. A project must be linked with one of project-type defined in admin section (using eRS Cloud Application). Let’s assume there are two project types defined as Medical (having id as 1) and Education (having id as 2), now while creating a new project, if project_type_id is given as 1 then it will get created under Medical type and same for Education when project_type_id is given as 2.
    title
    required
    String representing title / name of project. This can be a maximum of 100 characters long.
    email
    optional
    String value representing email address of project object. Email address must be properly formatted with a maximum length of 254 characters.
    project_start_date
    optional
    String value representing a date in ISO 8601 extended notation for date i.e. yyyy-MM-dd.
    end_date
    optional
    String value representing a date in ISO 8601 extended notation for date i.e. yyyy-MM-dd.
    tags
    optional
    An optional array of strings which could be attached to this project object as labels. This can be useful for the purpose of filtering, identification or other information.
    udf_*
    optional
    A user with admin rights can add custom fields. These fields can be used to capture additional information in Projects. Different types of projects may have a different set of user-defined fields. The value for user defined field can be passed as shown in example request. In given example udf_progress is a user defined field. Learn more

    Returns

    Code Description
    201
    Created
    Indicates that the operation was successful and a project get created successfully.
    400
    Bad Request
    Bad Request error occurs when a request is malformed, syntactically incorrect, missing required parameters or has any unknown parameter.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.

    List projects

    Returns a list of projects. The projects are returned sorted by title.

    GET /v1/projects

    Example Request

    curl -v \
    "https://app.eresourcescheduler.cloud/rest/v1/projects" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Request With Offset And Limit

    curl -v \
    "https://app.eresourcescheduler.cloud/rest/v1/projects?offset=1&limit=15" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Response

    {
      "total_count": 50,
      "offset": 1,
      "limit": 15,
      "data": [{
          "id": 1,
          "title": "Project-A",
          "type": {
            "name": "Satellite",
            "description": null,
            "id": 1
          },
          "email": "apollo@enbraun.com",
          "project_start_date": null,
          "end_date": null,
          "image": "https://erscloud/img/7aca31f5-29ae205ba315",
          "tags": ["NASA"],
          "is_archive": false,
          "created_on": "2018-08-20T09:25:34.925474Z",
          "created_by": {
            "name": "Rahul Sharma",
            "id": 118
          },
          "modified_on": "2018-09-28T12:32:44.896426Z",
          "modified_by": {
            "name": "Rahul Sharma",
            "id": 118
          },
          "udf_color": "#FF8A80;0",
          "udf_progress": 70,
          "udf_project_manager": "Gene Kranz",
          "udf_priority": {
            "name": "High",
            "description": null,
            "id": 21
          }
        },
        { ... },
        { ... },
        { ... }
      ]
    }
    

    REQUEST QUERY PARAMETERS

    Name Description
    limit
    optional
    The limit keyword is used to limit the number of records returned from a result set. If a limit count is given, no more than that many records will be returned (but possibly less, if the query itself yields less records)
    Default value of limit is 25
    Maximum value of limit can be 500
    offset
    optional
    Offset keyword is used to skip n items. If offset value is given as 10, then first 10 records will be skipped from result set. Offset is often used together with the Limit keyword.
    Default value of offset is 0

    Returns

    Code Description
    200
    OK
    Indicates that the operation was successful and list of projects is returned.
    400
    Bad Request
    Bad Request may occur when offset or limit value is negative.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.

    Retrieve a project

    GET /v1/projects/{ID}

    Example Request

    curl -v "https://app.eresourcescheduler.cloud/rest/v1/projects/1" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Response

    {
      "id": 1,
      "title": "Project-A",
      "type": {
        "name": "Satellite",
        "description": null,
        "id": 1
      },
      "email": "apollo@enbraun.com",
      "project_start_date": null,
      "end_date": null,
      "image": "https://erscloud/img/7aca31f5-29ae205ba315",
      "tags": ["NASA"],
      "is_archive": false,
      "created_on": "2018-08-20T09:25:34.925474Z",
      "created_by": {
        "name": "Rahul Sharma",
        "id": 118
      },
      "modified_on": "2018-09-28T12:32:44.896426Z",
      "modified_by": {
        "name": "Rahul Sharma",
        "id": 118
      },
      "udf_color": "#FF8A80;0",
      "udf_progress": 70,
      "udf_project_manager": "Gene Kranz",
      "udf_priority": {
        "name": "High",
        "description": null,
        "id": 21
      }
    }
    

    Retrieves the details of an existing project. You only need to provide the unique project identifier that was returned upon project creation as request parameter.

    Returns

    Code Description
    200
    OK
    This status code indicates that the operation was successful and a project get retrieved successfully .
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested project does not exist (i.e. There is no project with given id). This may also occur when requesting a project which has been deleted.

    Search projects

    POST /v1/projects/search

    Example Request For Filter In JSON Format

    curl -X POST \
    "https://app.eresourcescheduler.cloud/rest/v1/projects/search" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
    -d '{ 
          "project_type_id:eq": 1 
        }'
    

    Example Response

    {
      "total_count": 50,
      "offset": 1,
      "limit": 15,
      "data": [{
          "id": 1,
          "title": "Project-A",
          "type": {
            "name": "Satellite",
            "description": null,
            "id": 1
          },
          "email": "apollo@enbraun.com",
          "project_start_date": null,
          "end_date": null,
          "image": "https://erscloud/img/7aca31f5-29ae205ba315",
          "tags": ["NASA"],
          "is_archive": false,
          "created_on": "2018-08-20T09:25:34.925474Z",
          "created_by": {
            "name": "Rahul Sharma",
            "id": 118
          },
          "modified_on": "2018-09-28T12:32:44.896426Z",
          "modified_by": {
            "name": "Rahul Sharma",
            "id": 118
          },
          "udf_color": "#FF8A80;0",
          "udf_progress": 70,
          "udf_project_manager": "Gene Kranz",
          "udf_priority": {
            "name": "High",
            "description": null,
            "id": 21
          }
        },
        { ... },
        { ... },
        { ... }
      ]
    }
    

    Search Project API allows filtering the results returned in various ways. This enables a great power to find out what is needed. eRS Cloud API also allows filtering on custom defined fields with multiple operators and conditions to cover up complex scenarios for searching.

    A filter condition consists of three components which are field, operator and value. For example fetching only those projects having project type id 1, could be achieved by adding project_type_id:eq=1 to your query. If operator is not supplied, it takes default operator for field. Read more

    Below is a list of available fields, which allow filtering projects:

    Example Request For Filter By Passing Multiple Rules In JSON Format

    curl -X POST \
    "https://app.eresourcescheduler.cloud/rest/v1/projects/search" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
    -d '{ 
          "project_type_id:eq": 1, 
          "project_start_date:gt": "2015-04-02" 
        }'
    

    Filters for System-defined fields

    Field Code Operator Example
    project_type_id
  • eq (default)
  • any
  • "project_type_id":1
    "project_type_id:any":1
    email
  • has (default)  
  • eq
  • "email":"abc"
    "email:eq":"ujjwal@gmail.com"
    project_start_date
  • eq (default)
  • lt
  • gt
  • bt
  • ex
  • "project_start_date:eq":"2015-02-02"
    "project_start_date:lt":"2015-02-02"
    "project_start_date:gt":"2015-02-02"
    "project_start_date:bt":["2015-02-02","2015-04-05"]
    "project_start_date:ex":["2015-02-02","2015-04-04"]
    end_date
  • eq (default)
  • lt
  • gt
  • bt
  • ex
  • "end_date:eq":"2015-02-02"
    "end_date:lt":"2015-02-02"
    "end_date:gt":"2015-02-02"
    "end_date:bt":["2015-02-02","2015-04-05"]
    "end_date:ex":["2015-02-02","2015-04-04"]
    tags
  • any (default)
  • all
  • "tags":"["tagA", "tagB"]
    "tags:all":["tagB","tagC"]
    is_archive N/A "is_archive":true
    "is_archive":false

    For User-defined fields please check here.

    Update a project

    Updates specified project by setting the values of the parameters passed. Any parameters which is not provided remains unchanged. To unset existing value for a parameter, just pass an empty value i.e. null or undefined.

    This request accepts mostly the same arguments as Create Project API.

    PUT /v1/projects/{ID}

    Example Request

    curl -v -X PUT \
    "https://app.eresourcescheduler.cloud/rest/v1/projects/1" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
    -H "Content-Type: application/json" \
    -d '{
          "title": "Angola",
          "udf_progress": 70
        }' 
    

    REQUEST BODY PARAMETERS

    Name Description
    title
    required
    String representing the title of a project. This may be up to 100 characters.
    project_start_date
    optional
    String value representing a date in ISO 8601 extended notation for date i.e. yyyy-MM-dd. The project is started from this date.
    end_date
    optional
    String value representing a date in ISO 8601 extended notation for date i.e. yyyy-MM-dd. The project is considered ended / completed on this date.
    tags
    optional
    An optional array of strings which could be attached to this project object as labels. This can be useful for the purpose of filtering, identification or other information. This may be up to 50 characters.
    email
    optional
    String value representing email address associated with project object. Email address must be properly formatted with a maximum length of 254 characters.
    udf_*
    optional
    A user with admin rights can add custom fields. These fields can be used to capture additional information in Project. Different types of projects may have a different set of user-defined fields. The value for user defined field can be passed as shown in example request. In first example udf_progress is a user defined field. Learn more

    Returns

    Code Description
    200
    OK
    Indicates that the operation was successful and project is updated successfully.
    400
    Bad Request
    Bad Request occurs when a request is not well-formed, syntactically incorrect, empty required parameters or any unknown parameter is passed.
    Additionally, Bad request may also occur when :
    • User tries to update archived project.
    • User tries to update start date or last_date or both such that last date gets smaller than start date.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that project does not exist.

    Delete a project

    Permanently deletes requested project. It cannot be undone. By default, this operation will get failed if a project has any booking associated with it. To override this, forceful delete can be used which will delete all bookings and then ultimately delete the project object.

    DELETE /v1/projects/{ID}

    Example Request

    curl -v -X DELETE \
    "https://app.eresourcescheduler.cloud/rest/v1/projects/1" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Request For Forcefull Delete

    curl -v -X DELETE \
    "https://app.eresourcescheduler.cloud/rest/v1/rpojects/1?\
    force_delete_bookings=true" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV" 
    

    Returns

    Code Description
    200
    OK
    This status code indicates that the operation was successful and a project get deleted successfully.
    409
    Conflict
    Conflict indicates that the project can not be deleted as there are bookings associated with this project. If you wish to delete it any way you must use force delete option by passing true for parameter force_delete_bookings. This operation deletes all bookings of requested project and project itself (shown in example request).
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that requested project does not exist

    Tasks

    GET v1/projects/{ID}/tasks

    Task is assignments or jobs that are to be covered in the project.

    eRS Cloud API allows you to perform POST, GET, PUT, DELETE operation on Tasks.

    List Tasks

    Retrieves the Tasks list of specified project. The tasks are returned sorted by name.

    Example Request

    curl -v -X GET \
    "https://app.eresourcescheduler.cloud/rest/v1/projects/2/tasks" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Response

     {
        "total_count": 8,
        "data": [
        {
            "id": 9,
            "name": "TASK- 2A",
            "start_time": null,
            "end_time": null,
            "project_id": 2,
            "created_by": {
                "id": null,
                "name": null
            },
            "modified_by": {
                "id": null,
                "name": null
        },
        {...},
        {...},
        ]
    }
    

    ATTRIBUTES

    Name Description
    ID
    Integer
    The eRS Cloud generated ID for the task which is used to uniquely identified task object.
    name
    String
    Name describes the name of task. This field is a string type of field
    start_time
    String
    Start time describes the start time of task.
    end_time
    String
    End time describes the end time of task.
    project_id
    Integer
    eRS Cloud generated unique identifier for the project object.

    Returns

    Code Description
    200
    OK
    This status code indicates that the operation was successful and tasks get retrieved successfully .
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested project does not exist (i.e. There is no project with given id). This may also occur when requesting a project which has been deleted.




    Create a task

    Creates a new task assignment object.

    POST v1/projects/{ID}/tasks

    Example Request

     curl -v -X POST \
     "https://app.eresourcescheduler.cloud/rest/v1/projects/2/tasks" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
      -H "Content-Type: application/json" \
      -d '{"name": "TASK- 2A"}'
    

    REQUEST BODY PARAMETERS

    Name Description
    name
    required
    Name describes the name of task. This field is a string type of field
    start_time
    optional
    Start time describes the start time of task. This filed can be passed null, as eRS Cloud provids you the facility to create an task without start time. This field is a String type of field.
    end_time
    optional
    End time describes the end time of task. This filed can be passed null,as eRS Cloud provides you the facility to create an task without end time.This field is a String type of field.

    Returns

    Code Description
    201
    Created
    This status code indicates that the operation was successful and task get created successfully.
    400
    Bad Request
    Bad Request error occurs when a request is not malformed, syntactically incorrect, missing required parameters are or any unknown parameter is passed.
    Additionally, Bad request may also occur when :
    • User gives start time after end time
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.

    Update a task

    PUT v1/projects/{ID}/tasks/{Task_ID}

    Updates the specified task by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

    This request accepts mostly the same arguments as the task creation call.

    Example Request

     curl -v -X PUT \
     "https://app.eresourcescheduler.cloud/rest/v1/projects/8/tasks/9" \
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
      -H "Content-Type: application/json" \
      -d '{"name": "TASK- 2B"}'
    

    REQUEST BODY PARAMETERS

    Name Description
    name
    required
    Name describes the name of task. This field is a string type of field.This will throw an error if you post an empty value.
    start_time
    optional
    Start time describes the start time of task. This filed can be passed null, as eRS Cloud provids you the facility to create an task without start time. This field is a String type of field.
    end_time
    optional
    End time describes the end time of task. This filed can be passed null,as eRS Cloud provides you the facility to create an task without end time.This field is a String type of field.

    Returns

    Code Description
    200
    OK
    This indicates that the operation was successful and a task get updated successfully.
    400
    Bad Request
    Bad Request occurs when a request is not well-formed, syntactically incorrect, empty required parameters or any unknown parameter is passed.
    Additionally, Bad request may also occur when :
    • User tries to update start time that values after end time.
    • User tries to update end time that values before start time.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that project or task does not exist

    Delete a task

    DELETE v1/projects/{ID}/task/{Task_ID}

    Permanently deletes a task. It cannot be undone. By default, this operation will get failed if a task has any booking associated with it. To override this behaviour, forcefull remove can be used which will remove all task from bookings.

    Example Request

    curl -v -X DELETE \
    "https://app.eresourcescheduler.cloud/rest/v1/projects/1/tasks/2"\
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Request For Forcefull Delete

    curl -v -X DELETE \
    "https://app.eresourcescheduler.cloud/rest/v1/projects/1/tasks/2?remove_from_bookings=true"\
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Return

    Code Description
    200
    OK
    This status code indicates that the operation was successful and task get deleted successfully
    409
    Conflict
    Conflict indicates that the task can not be deleted as there are bookings associated with this task. If you wish to delete it any way you must use force delete option by passing true for parameter remove_from_bookings. This operation removes all task from bookings. This can not be undone. Example shown 👉
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that project or task does not exist

    Project Notes

    To capture additional information about a project, eRS Cloud provides the Notes. If one has to provide any new information to a project which is not captured from the filed, for such situations Notes are beneficial.

    eRS Cloud API allows you to perform POST, GET, PUT, DELETE operations on Notes.

    The Notes Of Archived Project remain available for the records.

    List notes

    GET v1/projects/{ID}/notes

    Retrieves the Notes list of specified project. You need to provide the unique project identifier that was returned upon project creation.The notes are returned which sorted by lastly modified or added.

    Example Request

    curl -v -X GET "https://app.eresourcescheduler.cloud/rest/v1/projects/8/notes"\
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Request With Offset And Limit

    curl -v -X GET \
    "https://app.eresourcescheduler.cloud/rest/v1/projects/8/notes?offset=1&limit=1"\
     -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Request With order_by

    curl -v -X GET \
    "https://app.eresourcescheduler.cloud/rest/v1/projects/8/notes?offset=1&limit=1&order_by=created_on" \
     -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Exmaple Response

    {
      "total_count": 3,
      "limit": 25,
      "offset": 0,
      "data": [
        {
          "id": 20,
          "created_on": "2018-11-21T11:20:48.828322+05:30",
          "content": "<p>Updated Content Value Given</p>",
          "modified_on": null,
          "created_by": {
            "id": -99,
            "name": "Testing User",
            "image_uuid": null
          },
          "modified_by": {
            "id": null,
            "name": null
          }
        },
        {...},
        {...},
        {...},
      ]
    }
    

    REQUEST QUERY PARAMETERS

    Name Description
    limit
    optional
    The limit keyword is used to limit the number of notes returned from a result set.
    The default value of limit is 25
    Maximum value of limit can be 100. If value of Limit is more than100 then it will get set Maximum value of limit which is 100.
    offset
    optional
    The Offset value allows you to specify the ranking number of the first item on the page .The Offset value is most often used together with the Limit keyword.
    The default value of offset is 0

    Ordering the notes

    REQUEST QUERY PARAMETERS

    Name Options Description
    Order_by
    optional
  • created_on (Default)
  • List of notes will be returned and sorted by it's created date.
  • modified_on
  • List of notes will be returned and sorted by it's latest modified date

    ATTRIBUTES

    Name Description
    id
    integer
    eRS Cloud generated unique identifier for the notes.
    content
    string
    Text written inside notes body .
    created_on
    string
    Time at which the notes object is created.
    modified_on
    string
    Describes the latest modification date.
    created_by
    object
    This field describes by whom notes is created .
    modified_by
    object
    This field describes by whom the modification is done.

    Returns

    Code Description
    200
    OK
    This indicates that the operation was successful and returned list of notes.
    400
    Bad Request
    Bad Request may occur when offset and limit value is negative.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that project id does not exist

    Example Request

    Create a note

    POST v1/projects/{ID}/notes

    Example Request

    
    curl -v -X POST "https://app.eresourcescheduler.cloud/rest/v1/projects/8/notes"\
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"\
      -H "Content-Type: application/json"\
      -d '{"content": "Hello Enbraun"}'
    

    REQUEST BODY PARAMETERS

    Name Description
    content
    required
    To create new note you have to pass the body from content parameter. Content param accepts plain text. Also, you can pass text with HTML tags as Notes are Multi Line Rich Text.

    Returns

    Code Description
    201
    Created
    This status code indicates that the operation was successful and created a note successfully.
    400
    Bad Request
    Bad Request error occurs when a request is malformed, syntactically incorrect, missing required parameters are or any unknown parameter is passed.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that project does not exist

    Update a note

    PUT v1/projects/{ID}/notes/{Note_ID}

    Updates the specified project's note by setting the value of the parameter passed. You need to provide the unique project identifier that was returned upon project creation and unique note identifier that was returend upon notes creation. If parameter is not provided then it will be left unchanged.

    This request accepts mostly the same argument as the note creation call.

    Example Request

    
    curl -v -X PUT "https://app.eresourcescheduler.cloud/rest/v1/projects/8/notes/4"\
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"\
      -H "Content-Type: application/json"\
      -d '{"content": "Hello World"}'
    

    REQUEST BODY PARAMETERS

    Name Description
    content
    required
    To update note you have to pass the body from content parameter. Content param accepts plain text. Also, you can pass text with HTML tags as Notes are Multi Line Rich Text.

    Returns

    Code Description
    200
    OK
    This indicates that the operation was successful and a note get updated successfully.
    400
    Bad Request
    Bad Request occurs when a request is not well-formed, syntactically incorrect, empty required parameters or any unknown parameter is passed.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that project or notes does not exist

    Delete a note

    DELETE v1/projects/{ID}/notes/{Note_ID}

    Permanently deletes a Note. It cannot be undone.You need to provide the unique project identifier that was returned upon project creation and unique note identifier that was returend upon notes creation.

    Example Request

    
    curl -v -X DELETE "https://app.eresourcescheduler.cloud/rest/v1/projects/8/notes/5"\
      -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Returns

    Code Description
    200
    OK
    This status code indicates that the operation was successful and a note get deleted successfully
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    This status code indicates that project or notes does not exist

    Booking

    Booking object

    Example Response

    {
      "id": 34,
      "resource": {
        "name": "Andy Murray",
        "id": 2
      },
      "role": {
        "name": "Business Analyst",
        "id": 1
      },
      "project": {
        "id": 5,
        "title": "Mars Rover"
      },
      "task": null,
      "start_time": "2018-12-26T09:00:00",
      "end_time": "2018-12-31T17:00:00",
      "unit": 1,
      "effort": 100.0,
      "tags": [],
      "created_on": "2018-09-07T04:09:45.254681Z",
      "created_by": {
        "name": "Rahul Sharma",
        "id": 118
      },
      "modified_on": "2018-11-21T06:23:02.494932Z",
      "modified_by": {
        "name": "Rahul Sharma",
        "id": 118
      }
    }
    

    Booking object represents an assignment or schedule of resource on a certain project or task for a particular time range. Resource can be booked / scheduled on a project (and task) with a defined effort and capacity along with other custom defined fields.

    ATTRIBUTES

    Following attributes are available for booking object. Booking object can also be customized to have additional attributes by an Admin user using eRS Cloud Application. To know about attributes currently applied for booking object please check Booking Profile API.

    Name Description
    id
    integer
    eRS Cloud-generated unique identifier for the booking object.
    resource
    object
    Resource object to which this booking belongs.
    project
    object
    Project object for which this booking was created.
    task
    object
    Task object defines what needs to be done. Tasks could be one of the defined tasks of booking's project object.
    role
    object
    Role object defines which role Resource needs to perform for this booking.
    start_time
    string
    Represents starting time of booking.
    end_time
    string
    Represents ending time of booking.
    effort
    float
    Effort value for this booking.
    unit
    integer
    Represents unit of effort for this booking. Unit could be one of (percent of capacity, booking hours,hours per day, FTE, Specific time per day)
    tags
    array of strings
    Tags are the list of strings (labels) attached to this booking object which could be used for the purpose of identification or other information.
    created_on
    string
    Timestamp at which this project object was created.
    created_by
    object
    Object representing user who created this booking object.
    modified_on
    string
    Represents latest modification timestamp.
    modified_by
    object
    Object representing most recent user who modified this booking object.
    udf_* Custom user-defined fields used to capture additional information of booking. User defined field can be of multiple types. Custom fields are very useful to configure booking objects to best fit requirements. In given example response, all keys starting with prefix udf_ are user defined custom fields. Learn more

    Create a booking

    POST v1/bookings

    Example Request:

     curl -v -X POST "https://app.eresourcescheduler.cloud/rest/v1/bookings" \
     -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
     -H "Content-Type: application/json" \
     -d '{ 
           "resource_id": 1, 
           "project_id" : 9, 
           "start_time" : "2017-06-01T09:00", 
           "end_time": "2017-06-11T17:00", 
           "effort": 100, 
           "unit": 1 
         }'
    

    Creates a new booking object.

    REQUEST BODY PARAMETERS

    Name Description
    resource_id
    required
    Id of resource object which is being booked or scheduled.
    project_id
    required
    Id of project object which this booking object is being created for.
    start_time
    required
    Represents start date and time for booking object. This field accepts value in ISO 8601 extended format for date-time i.e. yyyy-mm-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given).
    end_time
    required
    Represents end date and time for booking object. This field accepts value in ISO 8601 extended format for date-time i.e. yyyy-mm-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given). End date time must always be ahead of start date time by at least 15 minutes as a booking of less than 15 minutes is not allowed.
    role_id
    optional
    Id of role object which needs to be performed for this booking. This could be id of a role which targeted resource performs (i.e "Performing Role") or any other role (i.e. "Non-Performing-Role")
    effort
    optional
    This defines how much effort is needed to complete the task. Effort value is a floating point number which could not be less than 0 and greater than 99999999.99. If effort value is not provided system will take default value 0.
    unit
    optional
    Integer number (1-5) representing unit in which effort is being defined. Unit value could be one of the following :
  • 1 for 'Percent of capacity' : This is default unit for booking. This represents effort in percentage of capacity of intended resource for defined time range.
  • 2 for 'Total Booking Hours' : This defines effort value in fixed hours which doesn't get changed upon changes in booking.
  • 3 for 'Hours Per day' : This could be used where a certain no of hours per day need to be spend for a booking. For example 4 hours per day (working day).
  • 4 for 'Full Time Equivalent' : Full time equivalent is calculated using FTE calendar defined in Admin section. Capacity from FTE calendar for defined time in booking, is considered as 1 FTE.
  • 5 for 'Time Per Day' : It is useful where effort needs to put in on a particular time of every working day i.e. 4:15 PM to 5:30 PM daily. Time portion of start_time argument is considered as per day start time, and Time portion of end_time argument is considered per day end time for this booking.
  • tags
    optional
    An optional array of strings which could be attached to this booking object as labels. This can be useful for the purpose of identification or other information.
    udf_*
    optional
    A user with admin rights can add custom fields. These fields can be used to capture additional information in Projects. Different types of projects may have a different set of user-defined fields. The value for user defined field can be passed as shown in example request. In given example udf_progress is a user defined field. Learn more

    Returns

    Code Description
    201
    Created
    This status code indicates that the operation was successful and a booking is created successfully.
    400
    Bad Request
    Bad Request error occurs when a request is malformed, syntactically incorrect, missing required parameters or any unknown parameter is passed. Additionally, Bad request may also occur in one of these conditions :
    • Booking is starting before the start_date of resource or ending after the last_working_date of resource (if resource has a last_working_date defined.)
    • Resource is Archived i.e. if targeted resource has a last working date of past.
    • Project is marked as Archived.
    • Duration of booking is more than 5 years.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.

    List bookings

    Returns list of bookings. The bookings are returned sorted by booking's start_time and booking's id.

    GET /v1/bookings

    Example Request

    curl -v "https://app.eresourcescheduler.cloud/rest/v1/bookings?\
    start=2018-01-01&end=2018-12-31" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Request With Offset And Limit

    curl -v "https://app.eresourcescheduler.cloud/rest/v1/bookings?\
    start=2018-01-01&end=2018-12-31&offset=1&limit=1" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Response

    {
      "total_count": 7,
      "data": [{
          "id": 34,
          "resource": {
            "name": "Andy Murray",
            "id": 2
          },
          "role": {
            "name": "Business Analyst",
            "id": 1
          },
          "project": {
            "id": 5,
            "title": "Mars Rover"
          },
          "task": null,
          "start_time": "2018-12-26T09:00:00",
          "end_time": "2018-12-31T17:00:00",
          "unit": 1,
          "effort": 100.0,
          "tags": [],
          "created_on": "2018-09-07T04:09:45.254681Z",
          "created_by": {
            "name": "Rahul Sharma",
            "id": 118
          },
          "modified_on": "2018-11-21T06:23:02.494932Z",
          "modified_by": {
            "name": "Rahul Sharma",
            "id": 118
          }
        },
        { ... },
        { ... }
      ]
    }
    

    REQUEST QUERY PARAMETERS

    Name Description
    limit
    optional
    The limit keyword is used to limit the number of records returned from a result set. If a limit count is given, no more than that many records will be returned (but possibly less, if the query itself yields less records)
    Default value of limit is 500
    Maximum value of limit can be 5000
    offset
    optional
    Offset keyword is used to skip n items. If offset value is given as 10, then first 10 records will be skipped from result set. Offset is often used together with the Limit keyword.
    Default value of offset is 0
    start
    optional
    String value representing start date in ISO 8601 extended notation for date i.e. yyyy-MM-dd. This is used to filter bookings starting on or after this date.
    end
    optional
    String value representing end date in ISO 8601 extended notation for date i.e. yyyy-MM-dd. This is used to filter bookings starting before this date.
    Note : By default if start & end arguments are omitted, then bookings of current month will be returned. If bookings of a certain period are needed, then both start & end arguments required. You have to give values of both start and end to get bookings in that duration. If only one argument start or end is passed then a bad request error is raised.

    Returns

    Code Description
    200
    OK
    This indicates that the operation was successful and list of bookings is returned.
    400
    Bad Request
    Bad Request may occur when offset or limit value is negative integer.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.

    Retrieve a booking

    GET v1/bookings/{ID}

    Example Request

    curl -v -X GET "https://app.eresourcescheduler.cloud/rest/v1/bookings/25" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Example Response

    {
      "id": 34,
      "resource": {
        "name": "Andy Murray",
        "id": 2
      },
      "role": {
        "name": "Business Analyst",
        "id": 1
      },
      "project": {
        "id": 5,
        "title": "Mars Rover"
      },
      "task": null,
      "start_time": "2018-12-26T09:00:00",
      "end_time": "2018-12-31T17:00:00",
      "unit": 1,
      "effort": 100.0,
      "tags": [],
      "created_on": "2018-09-07T04:09:45.254681Z",
      "created_by": {
        "name": "Rahul Sharma",
        "id": 118
      },
      "modified_on": "2018-11-21T06:23:02.494932Z",
      "modified_by": {
        "name": "Rahul Sharma",
        "id": 118
      }
    }
    

    Retrieves the details of an existing booking. You only need to provide the unique booking identifier that was returned upon booking creation.

    Returns

    Code Description
    200
    OK
    This status code indicates that the operation was successful and a booking successfully returned.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested booking does not exist (i.e. There is no booking with given id). This may also occur when requesting a booking which has been deleted.

    Search bookings

    POST /v1/bookings/search

    Example Request For Filter In JSON Format

    curl -X POST "https://app.eresourcescheduler.cloud/rest/v1/bookings/search?\
    start=2018-01-01&end=2018-08-09" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
    -d '{ 
          "id": 1
        }'
    

    Example Request For Filter By Passing multiple filters In JSON Format

    curl -X POST "https://app.eresourcescheduler.cloud/rest/v1/bookings/search?\
    start=2018-01-01&end=2018-08-09" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
    -d '{        
           "resource":{"id":2}, 
           "project":{"id":9},
           "role_id": 1
         }'
    

    Example Response

    {
      "total_count": 7,
      "data": [{
          "id": 34,
          "resource": {
            "name": "Andy Murray",
            "id": 2
          },
          "role": {
            "name": "Business Analyst",
            "id": 1
          },
          "project": {
            "id": 5,
            "title": "Mars Rover"
          },
          "task": null,
          "start_time": "2018-12-26T09:00:00",
          "end_time": "2018-12-31T17:00:00",
          "unit": 1,
          "effort": 100.0,
          "tags": [],
          "created_on": "2018-09-07T04:09:45.254681Z",
          "created_by": {
            "name": "Rahul Sharma",
            "id": 118
          },
          "modified_on": "2018-11-21T06:23:02.494932Z",
          "modified_by": {
            "name": "Rahul Sharma",
            "id": 118
          }
        },
        { ... },
        { ... }
      ]
    }
    

    Search Booking API allows filtering the results set in various ways. This enables a great power to find out what is needed. eRS Cloud API also allows filtering on custom defined fields with multiple operators and conditions to cover up complex scenarios for searching.

    A filter condition consists of three components which are field, operator and value. For example, fetching only those bookings having tag tagA or tagB, could be achieved by adding "tags:any": ["tagA", "tagB"] to request body. If operator is not supplied, it takes default operator for field.

    Below is a list of available fields, which allow filtering bookings:

    Field Type Operator Example
    role_id
  • any (default)
  • eq
  • "role_id:any": [1,2]
    "role_id:eq": 1
    tags
  • any (default)
  • all
  • "tags:any": ["tagA","tagB"]
    "tags:all": ["tagA","tagB"]

    Additionally, bookings can also be filtered using resource fields, project fields and custom fields of bookings. An example request for fetching only booking having resource_id as 2, project_id as 9 and role_id as 1 is shown.

    Update a booking

    Updates the specified booking by setting values of parameters passed. Values of any parameters which are not provided will be unchanged.

    PUT /v1/bookings/{ID}

    Example Request

    curl -v -X PUT "https://app.eresourcescheduler.cloud/rest/v1/bookings/25" \
    -H "Authorization: Bearer B8x5Vj1O65r6wnoV" \
    -H "Content-Type: application/json" \
    -d '{ 
          "resource_id": 3, 
          "project_id" : 4, 
          "start_time" : "2017-06-05T09:00", 
          "unit": 3 
        }'
    

    REQUEST BODY PARAMETERS

    Name Description
    resource_id
    required
    Id of resource object which is being booked or scheduled. This will throw an error if you post an empty value.
    project_id
    required
    Id of project object which this booking object is being created for. This will throw an error if you post an empty value.
    start_time
    required
    Represents start date and time for booking object. This field accepts value in ISO 8601 extended format for date-time i.e. yyyy-mm-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given). This will throw an error if you post an empty value.
    end_time
    required
    Represents end date and time for booking object. This field accepts value in ISO 8601 extended format for date-time i.e. yyyy-mm-ddThh:mm:ss. The value must be snapped in 15 minutes interval, which effectively means that minutes values should be one of(00/15/30/45) and seconds value should always be 0. (if given). End date time must always be ahead of start date time by at least 15 minutes as a booking of less than 15 minutes is not allowed. This will throw an error if you post an empty value.
    role_id
    optional
    Id of role object which needs to be performed for this booking. This could be id of a role which targeted resource performs (i.e "Performing Role") or any other role (i.e. "Non-Performing-Role")
    effort
    optional
    This defines how much effort is needed to complete the task. Effort value is a floating point number which could not be less than 0 and greater than 99999999.99. If effort value is not provided system will take default value 0.
    unit
    optional
    Integer number (1-5) representing unit in which effort is being defined. Unit value could be one of the following :
  • 1 for 'Percent of capacity' : This is default unit for booking. This represents effort in percentage of capacity of intended resource for defined time range.
  • 2 for 'Total Booking Hours' : This defines effort value in fixed hours which doesn't get changed upon changes in booking.
  • 3 for 'Hours Per day' : This could be used where a certain no of hours need to be spend for a booking. For example 4 hours per day (working day).
  • 4 for 'Full Time Equivalent' : Full time equivalent is calculated using FTE calendar defined in Admin section. Capacity from FTE calendar for defined time in booking, is considered as 1 FTE.
  • 5 for 'Time Per Day' : It is useful where effort needs to put in on a particular time of every working day i.e. 4:15 PM to 5:30 PM daily. Time portion of start_time argument is considered as per day start time, and Time portion of end_time argument is considered per day end time for this booking.
  • tags
    optional
    Tags is an optional filed. Tags are attached to this booking object which could be used for the purpose of identification or other information.. This may be up to 50 characters. This will be blank if you post an empty value.
    udf_*
    optional
    A user with admin rights can add such custom fields. These fields can be used to capture additional info in bookings. Learn more

    Returns

    Code Description
    200
    OK
    This indicates that the operation was successful and a booking get updated successfully.
    400
    Bad Request
    Bad Request error occurs when a request is malformed, syntactically incorrect, empty required parameters or any unknown parameter is passed. Additionally, Bad request may also occur in one of these conditions :
    • Trying to update start_time or end_time such that end_time gets earlier than start_time.
    • Trying to update start_time of booking before the start_date of resource or end_time after the last_working_date of resource (if resource has a last_working_date defined.)
    • Trying to update a booking of archived resource
    • Trying to update bookings of archived project.
    • Duration of booking is more than 5 years.
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested booking does not exist (i.e. There is no booking with given id). This may also occur when requesting a booking which has been deleted.

    Delete a booking

    Permanently deletes a booking. It cannot be undone.

    DELETE /v1/bookings/{ID}

    Example Request

    curl -v -X DELETE "https://app.eresourcescheduler.cloud/rest\
    /v1/bookings/1" -H "Authorization: Bearer B8x5Vj1O65r6wnoV"
    

    Returns

    Code Description
    200
    OK
    This status code indicates that the operation was successful and a booking get deleted successfully
    403
    Forbidden
    Authorization failed due to insufficient permissions. This occurs when user does not have enough access rights to perform this action. Access for each user can be controlled by an Administrator using eRS Cloud Application.
    404
    Not Found
    Not Found error occurs when requested booking does not exist.

    Filters

    Definition

    The filter parameter allows for filtering the results returned from the various endpoint in various ways.

    Filters are made up of rules, with a user-defined or system-defined field, a filter operator and a value.

    when specifying a filter, the field-name(API Code) and filter operator is always separated by a colon: If an operator is omitted, then default operator (which could be different depending upon field type.) will get applied.

    Operator

    The full list of all operators is shown below.

    Operator Meaning
    any Result will be displayed if it contains any occurrence within given values from record set.
    all Result will be displayed if it contains all occurrence of given values from record set.
    has Result will be displayed if it has the given value from record set.
    eq Result will be displayed if it has equal value to given input from record set.
    gt Result will be displayed of if it has greater values for given input from record set.
    lt Result will be displayed of if it has lesser values for given input from record set.
    bt Result will be displayed for values which vary between given range from record set.
    ex Result will be displayed for values which vary excluding given range from record set.

    Filters for User-defined fields

    Field Type Operators Example
    Simple Text
  • has (default)
  • eq
  • -d "simtext": "Simple Text" (default)
  • -d "simtext:has": "Simple Text"
  • -d "simtext:eq": "Simple Text Ed"
  • Integer Number
  • eq (default)
  • lt
  • gt
  • bt
  • ex
  • -d "int_field": 41
  • -d "int_field:eq": 41
  • -d "int_field:lt": 41
  • -d "int_field:gt": 41
  • -d "int_field:lt": 41
  • -d "int_field:bt": "41|121"
  • -d "int_field:bt": 41
  • -d "int_field:ex": "41|121"
  • -d "int_field:ex": 41
  • Fractional Number
  • eq (default)
  • lt
  • gt
  • bt
  • ex
  • -d "float_field": 12.1
  • -d "float_field:eq": 12.1
  • -d "float_field:lt": 45.6
  • -d "float_field:gt": 121.1
  • -d "float_field:bt": "1.0|121.1"
  • -d "float_field:bt": 22.6
  • -d "float_field:ex": "15.7|45.6"
  • -d "float_field:ex": 45.6
  • Date
  • eq (default)
  • lt
  • gt
  • bt
  • ex
  • -d "emp_birthday": "1992-02-12"
  • -d "emp_birthday:eq": "1992-02-12"
  • -d "emp_birthday:lt": "1992-02-12"
  • -d "emp_birthday:gt": "1992-02-12"
  • -d "emp_birthday:bt":"1992-02-12|1999-07-07"
  • -d "emp_birthday:bt": "1992-02-12"
  • -d "emp_birthday:ex" : "1992-02-12|1997-01-27"
  • -d "emp_birthday:ex": "1992-02-12"
  • DateTime
  • eq (default)
  • lt
  • gt
  • bt
  • ex
  • -d "date_time_field": "2018-06-06T18:30:00Z"
  • -d "date_time_field:eq": "2018-06-06T18:30:00Z"
  • -d "date_time_field:lt": "2018-06-06T18:30:00Z"
  • -d "date_time_field:gt": "2018-06-06T18:30:00Z"
  • -d "date_time_field:bt": "2018-06-06T18:30:00Z| 2018-06-06T18:30:00Z"
  • -d "date_time_field:bt": "2018-06-06T18:30:00Z"
  • -d "date_time_field:ex": "2018-06-06T18:30:00Z| 2018-06-06T18:30:00Z"
  • -d "date_time_field:ex": "2018-06-06T18:30:00Z"
  • Email
  • has (default)
  • eq
  • -d "email": "@"
  • -d "email:has": "a"
  • -d "email:eq": "ana@company.com"
  • Checkbox Default value is true, accepts value true and false
  • -d "check_field": true
  • -d "check_field": false
  • Checkbox Group
  • any (default)
  • all
  • -d "check_group_field": "16|18"
  • -d "check_group_field:any": "17|10"
  • -d "check_group_field:all": "16|17"
  • Radio Group
  • eq (default)
  • any
  • -d "radio_field": 15
  • -d "radio_field:eq": 15
  • -d "radio_field:any": 15
  • Label
  • eq (default)
  • any
  • -d "label_field": 18
  • -d "label_field:eq": 18
  • -d "label_field:any": 18
  • Drop Down Single Select
  • eq (default)
  • any
  • -d "ddss_field": 15
  • -d "ddss_field:eq": 15
  • -d "ddss_field:any": 15
  • Drop Down Multi Select
  • any (default)
  • all
  • -d "ddms_field": "20|21"
  • -d "ddms_field:any": "20|21"
  • -d "ddms_field:all": "20|21"