Workspace Resource Skills

Workspace Resource Skills represent skills that have been assigned to a workspace resource.

Operations

Fetching a list of Workspace Resource Skills

Request

Returns a list of Workspace Resource Skills that represent the skills associated with workspace resources visible to the logged in user.

This endpoint returns structured Workspace Resource Skill 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 workspace_resource_skills top-level JSON key. Please see our Response Format section for more information.

Query

by_skill_idinteger, (int32)

Only includes associated skill, by the skill ID.

by_skill_idsstring

Only includes associated skills. Input is a comma separated list of ids or an array.

by_skill_namestring

Only includes associated skills, by the name of the skill.

includestring

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

creator (User) - References the user who has created the skill association.
skill (Skill) - References the skill assigned to the object.
workspace_resource (WorkspaceResource) - References the workspace resource who has been assigned the skill.

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.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: created_at:asc, created_at:desc, skill_name:asc, and skill_name:desc.

Default:"created_at:desc"

pageinteger, (int32)

Default:1

per_pageinteger, (int32), <= 200

Default:20

workspace_resource_idsArray of integers, (int32)

Only includes workspace resource skills assigned to a workspace resource, by workspace resource ID.

GET

/workspace_resource_skills

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/workspace_resource_skills?by_skill_id=0&by_skill_ids=string&by_skill_name=string&include=string&only=string&order=created_at%3Adesc&page=1&per_page=20&workspace_resource_ids=0'

Responses

A list of Workspace Resource Skills have been retrieved.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

workspace_resource_skillsobject

skillsobject

usersobject

workspace_resourcesobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "workspace_resource_skills": {
    "property1": {
      "cached_skill_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "level": 0,
      "max_level": 0,
      "skill_id": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_resource_id": "string"
    },
    "property2": {
      "cached_skill_name": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "creator_id": "string",
      "level": 0,
      "max_level": 0,
      "skill_id": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "workspace_resource_id": "string"
    }
  },
  "skills": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "external_reference_ids": [
        "string"
      ],
      "max_level": "string",
      "name": "string",
      "skill_category_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "description": "string",
      "external_reference_ids": [
        "string"
      ],
      "max_level": "string",
      "name": "string",
      "skill_category_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "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"
      ]
    }
  },
  "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"
    }
  }
}