Requests

API Endpoints to access Requests

Get Request Details

• Endpoint: GET /requests/{request_id}

• Description: Retrieves the details of a specific request.

• Path Parameters:

  • request_id (integer, required): The unique identifier of the request.

• Response: 200 OK Returns a JSON object representing the request details.

Create Request

• Endpoint: POST /requests/

• Description: Creates a new request.

• Request Body:

  • title__-1 (string, required): The title of the request.

  • address__-3 (string, required): The address related to the request.

  • primaryemail__-32 (string, required): The primary email associated with the request.

  • parentProjectId__-1001 (number, required): The ID of the parent project.

  • blueprintId__-1000 (number, required): The ID of the blueprint.

• Response: 201 CREATED Returns a JSON object representing the newly created request.

Note: The field names in the request body must match the api_name of the respective properties, which can be obtained using the "List Request Properties" endpoint.

List Requests

• Endpoint: GET /requests

• Description: Retrieves a list of requests with pagination.

• Query Parameters:

  • page (integer): The page number of the results.

  • page_size (integer): The number of requests per page.

• Response: 200 OK Returns a JSON array containing request objects.

List Request Properties

• Endpoint: GET /requests/properties

• Description: Retrieves a list of properties available for requests.

• Response: 200 OK Returns a JSON object containing an array of request properties.

Note: For properties of the person type, a user ID must be provided.