Capabilities

Перечислите возможности

get

Возвращает набор действий, назначенных участнику в контексте. Клиент может выбрать фильтрацию действий аналогично тому, как фильтруются рабочие пакеты. В дополнение к предоставленным фильтрам сервер сократит результирующий набор, чтобы он содержал только те действия, для которых запрашивающий клиент имеет достаточные разрешения

Authorizations
AuthorizationstringRequired
Query parameters
filtersstringOptional

JSON, определяющий условия фильтрации. Принимает тот же формат, который возвращается конечной точкой запросы.

  • действие: Получение всех возможностей определенного действия

  • участник: Получение всех возможностей участника

  • контекст: Получение всех возможностей в контексте. Обратите внимание, что для контекста проекта клиенту необходимо указать p{id}, например p5, а для глобального контекста - g

Example: [{ "principal": { "operator": "=", "values": ["1"] }" }]
sortBystringOptional

JSON, определяющий критерии сортировки. Принимает тот же формат, который возвращается конечной точкой запросы. В настоящее время поддерживаются следующие виды сортировки:

  • id: Сортировка по идентификатору возможностей
Default: [["id", "asc"]]Example: [["id", "asc"]]
Responses
200

OK

application/hal+json
ResponseobjectExample: {"_links":{"self":{"href":"/api/v3/capabilities"},"changeSize":{"href":"/api/v3/capabilities?pageSize={size}","templated":true},"jumpTo":{"href":"/api/v3/capabilities?offset={offset}","templated":true}},"total":4,"count":4,"_type":"Collection","_embedded":{"elements":[{"_links":{"self":{"href":"/api/v3/capabilities/work_packages/create/p123-567"},"action":{"href":"/api/v3/actions/work_packages/create","title":"Add work package"},"context":{"href":"/api/v3/projects/123","title":"A project"},"principal":{"href":"/api/v3/users/567","title":"Some user"}},"_type":"Capability","id":"work_packages/create/p123-567"},{"_links":{"self":{"href":"/api/v3/capabilities/work_packages/assignee/p123-567"},"action":{"href":"/api/v3/actions/work_packages/assignee"},"context":{"href":"/api/v3/projects/123","title":"A project"},"principal":{"href":"/api/v3/users/567","title":"Some user"}},"_type":"Capability","id":"work_packages/assignee/p123-567"},{"_links":{"self":{"href":"/api/v3/capabilities/memberships/create/p345-821","title":"Create members"},"action":{"href":"/api/v3/actions/memberships/create"},"context":{"href":"/api/v3/projects/345","title":"A project"},"principal":{"href":"/api/v3/users/821","title":"Some user"}},"_type":"Capability","id":"memberships/create/p345-821"},{"_links":{"self":{"href":"/api/v3/capabilities/users/delete/g-567","title":"Delete user"},"context":{"href":"/api/v3/capabilities/context/global","title":"Global"},"principal":{"href":"/api/v3/users/567","title":"Some user"}},"_type":"Capability","id":"users/delete/g-567"}]}}
get
/api/v3/capabilities
GET /op/api/v3/capabilities HTTP/1.1
Host: example.u-meteor.ru
Authorization: Basic username:password
Accept: */*
200

OK

{
  "_embedded": {
    "elements": [
      {
        "_links": {
          "action": {
            "href": "/api/v3/actions/work_packages/create",
            "title": "Add work package"
          },
          "context": {
            "href": "/api/v3/projects/123",
            "title": "A project"
          },
          "principal": {
            "href": "/api/v3/users/567",
            "title": "Some user"
          },
          "self": {
            "href": "/api/v3/capabilities/work_packages/create/p123-567"
          }
        },
        "_type": "Capability",
        "id": "work_packages/create/p123-567"
      },
      {
        "_links": {
          "action": {
            "href": "/api/v3/actions/work_packages/assignee"
          },
          "context": {
            "href": "/api/v3/projects/123",
            "title": "A project"
          },
          "principal": {
            "href": "/api/v3/users/567",
            "title": "Some user"
          },
          "self": {
            "href": "/api/v3/capabilities/work_packages/assignee/p123-567"
          }
        },
        "_type": "Capability",
        "id": "work_packages/assignee/p123-567"
      },
      {
        "_links": {
          "action": {
            "href": "/api/v3/actions/memberships/create"
          },
          "context": {
            "href": "/api/v3/projects/345",
            "title": "A project"
          },
          "principal": {
            "href": "/api/v3/users/821",
            "title": "Some user"
          },
          "self": {
            "href": "/api/v3/capabilities/memberships/create/p345-821",
            "title": "Create members"
          }
        },
        "_type": "Capability",
        "id": "memberships/create/p345-821"
      },
      {
        "_links": {
          "context": {
            "href": "/api/v3/capabilities/context/global",
            "title": "Global"
          },
          "principal": {
            "href": "/api/v3/users/567",
            "title": "Some user"
          },
          "self": {
            "href": "/api/v3/capabilities/users/delete/g-567",
            "title": "Delete user"
          }
        },
        "_type": "Capability",
        "id": "users/delete/g-567"
      }
    ]
  },
  "_links": {
    "changeSize": {
      "href": "/api/v3/capabilities?pageSize={size}",
      "templated": true
    },
    "jumpTo": {
      "href": "/api/v3/capabilities?offset={offset}",
      "templated": true
    },
    "self": {
      "href": "/api/v3/capabilities"
    }
  },
  "_type": "Collection",
  "count": 4,
  "total": 4
}

Возможности просмотра

get
Authorizations
AuthorizationstringRequired
Path parameters
idstringRequired

идентификатор возможности

Example: work_packages/create/p123-567
Responses
200

OK

application/hal+json
ResponseobjectExample: {"_links":{"self":{"href":"/api/v3/capabilities/work_packages/create/p123-567"},"action":{"href":"/api/v3/actions/work_packages/create","title":"Add work package"},"context":{"href":"/api/v3/projects/123","title":"A project"},"principal":{"href":"/api/v3/users/567","title":"Some user"}},"_type":"Capability","id":"work_packages/create/p123-567"}
get
/api/v3/capabilities/{id}
GET /op/api/v3/capabilities/{id} HTTP/1.1
Host: example.u-meteor.ru
Authorization: Basic username:password
Accept: */*
{
  "_links": {
    "action": {
      "href": "/api/v3/actions/work_packages/create",
      "title": "Add work package"
    },
    "context": {
      "href": "/api/v3/projects/123",
      "title": "A project"
    },
    "principal": {
      "href": "/api/v3/users/567",
      "title": "Some user"
    },
    "self": {
      "href": "/api/v3/capabilities/work_packages/create/p123-567"
    }
  },
  "_type": "Capability",
  "id": "work_packages/create/p123-567"
}