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
Method	Group Access
GET	Administrator, Manager, Resource, Executive

Allowed Filters
Filter Name	Required?	Expects	Default	Description
projectid	no	integer¹
active	no	boolean		This filter will automatically be applied to resource users, as they cannot see inactive modules.
personid	no	integer
offset	no	integer		Return projectmodules starting from the nth projectmodule.
limit	no	integer	10	Sets a limit to the amount of projectmodules returned in the response.

¹ Indicates that multiple values are allowed, in CSV format (e.g. "3,5,11,19").
² 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/?projectid={value}

Note: You can string together multiple filters.

Member

Allowed HTTP Methods
Method	Group Access
GET	Administrator, Manager, Resource, Executive
DELETE	Administrator
POST	Administrator
PUT	Administrator

Settable Fields for PUT and POST Requests
Field Name	Required?	Expects	Default	Description
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.

Response Fields

The fields below are returned in GET responses. Boolean values are "t" / "f" strings. Numeric IDs and floats are returned as strings. Nullable fields may be JSON null.

Response Fields
Field Name	Nullable	Description
id	no	Unique identifier for the project module row
projectid	no	ID of the parent project
moduleid	yes	ID of the global `/module/` record when this row is based on a default module (empty or null for a custom project-only module)
description	yes	Optional description for this project module instance (may be empty) (Admin only)
active	no	Whether the project module is active ("t") or inactive ("f")
modulename	no	Display name of the module for this project
module	no	Module name (often the same value as `modulename`)

Sample response object. Non-null values are strings in JSON (including IDs, numeric fields, and booleans as "t" / "f"). Nullable fields may be JSON null when absent.

{
    "id": "123456",
    "projectid": "123456",
    "moduleid": null,
    "description": "Description text",
    "active": "t",
    "modulename": "string value",
    "module": "Module Name"
}

When retrieving a collection (GET /projectmodule/), the response envelope includes: personid (authenticated user's ID), status ("OK"), code (200), listcount (total matching records before limit/offset), and projectmodule (array of result objects). Defaults, no cap on limit, and how to paginate using listcount are described in the API Introduction (Pagination).

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}/

{
    "moduleid": value,
    "description": value
}

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

Documentation

Resources

API Support

Looking for help?
Contact our support team.

OpenAPI

OpenAPI JSON spec (public)

Swagger UI on SwaggerHub

Start tracking time today

Connect Intervals to the tools and workflows your team already uses.

Try Intervals free