Resource Requests

Resource Requests are used as a method for a requestor to ask an approver to staff a resource. Resource Requests are associated to a workspace resource and must have an approver associated.

Operations

Fetching a list of Resource Requests

Request

Returns resource requests visible to the logged in user by default. When pending_requests_only filter is set to true, the endpoint returns only pending resource requests.

This endpoint returns structured Resource Requests objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the resource_requests top-level JSON key. Please see our Response Format section for more information.

Query

created_afterstring, (date-time)

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring, (date-time)

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

approvers (User) - The users available to approver or reject the resource request.
creator (User) - The person submitting the resource request.
resource (WorkspaceResource) - The resource the request is intending to assign a user to.

onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

pageinteger, (int32)

Default:1

pending_requests_onlyboolean

Returns only the pending resource requests.

per_pageinteger, (int32), <= 200

Default:20

requests_for_approverstring

Returns only the requests where the specified user is the approver.

updated_afterstring, (date-time)

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring, (date-time)

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

GET

/resource_requests

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/resource_requests?created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&include=string&only=string&page=1&pending_requests_only=true&per_page=20&requests_for_approver=string&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z'

Responses

A list of Resource Requests have been retrieved.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

resource_requestsobject

workspace_resourcesobject

usersobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "resource_requests": {
    "property1": {
      "approver_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "resource_id": "string",
      "status": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "approver_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "resource_id": "string",
      "status": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "workspace_resources": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_field_value_ids": [
        "string"
      ],
      "display_label": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "label": "string",
      "organization_membership_id": "string",
      "participation_id": "string",
      "photo_path": "string",
      "resource_bill_rate": 0,
      "resource_cost_rate": 0,
      "role_id": "string",
      "role_initials": "string",
      "role_name": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string",
      "workspace_id": 0,
      "workspace_title": "string"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "custom_field_value_ids": [
        "string"
      ],
      "display_label": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "label": "string",
      "organization_membership_id": "string",
      "participation_id": "string",
      "photo_path": "string",
      "resource_bill_rate": 0,
      "resource_cost_rate": 0,
      "role_id": "string",
      "role_initials": "string",
      "role_name": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string",
      "workspace_id": 0,
      "workspace_title": "string"
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  }
}