Intervals API Resource: projectmodule

The base URL for this resource is located at
https://api.myintervals.com/projectmodule/

The project module resource is used to retrieve modules assigned to a project. The moduleid field refers to the id of the default module.

Collection

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource, Executive
Allowed Filters
Filter NameRequired?ExpectsDefaultDescription
projectid no integer1
active no boolean This filter will automatically be applied to resource users, as they cannot see inactive modules.
personid no integer
offset no integer
limit no integer 10

1 Indicates that multiple values are allowed, in CSV format (e.g. "3,5,11,19").
2 This field accepts HTML, but certain HTML elements may be stripped out.

Examples

To retrieve the entire list of this resource:

GET /projectmodule/

To filter the list based on certain parameters:

GET /projectmodule/?limit={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
MethodGroup Access
GETAdministrator, Manager, Resource, Executive
DELETEAdministrator
POSTAdministrator
PUTAdministrator
Settable Fields for PUT and POST Requests
Field NameRequired?ExpectsDefaultDescription
projectid yes integer Once a project ID has been set for a project module, it cannot be changed. It must be deleted for this project and then re-created for the new project.
moduleid no integer 0 moduleid corresponds to the default module id located on the 'module' resource. ONLY REQUIRED IF adding a default module, NOT REQUIRED if adding a custom module.
description no string
active yes boolean
module no string (155) The name of the module. REQUIRED IF adding a custom module OR converting a default module to a custom module.

string (xxx) indicates a string with a maximum length of xxx characters.

Examples

To retrieve one member resource:

GET /projectmodule/{id}/

Assuming no errors, the server will respond with 200 OK and the object requested.

To delete a particular member resource:

DELETE /projectmodule/{id}/

Assuming no errors, the server will respond with 200 OK.

To create a new member resource:

POST /projectmodule/
{
    "projectid": value,
    "active": value
}

Assuming no errors, the server will respond with 201 Created and the newly-created element. This will allow you to get the id of the item you just created and verify the field values. Note: Only required fields were listed here. The entire list of possible fields is above.

To update a member resource:

PUT /projectmodule/{id}/
{
    "description": value,
    "module": value
}

Assuming no errors, the server will respond with 202 Accepted and the entire element. This will allow you to verify the field values.

 

Don’t have an Intervals account? Start your own unlimited trial.

No credit card required. No software to install. Cancel any time.

Try it Free