Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Get

...

all users' skills

Returns all skills of the specified usera skill map for all users.

  • GET /rest/skillsforjira/1/expertise/{userKey}

  • Request:

    • userKey (path): Key of the target user. RequiredNone

  • Response [JSON]:

    • skills: An array of all skill names that the user has expertise inskllsByUserKey: Skill map for all users

Example:

  • Request:

    Code Block
    HTTP GET: http://your-instance.com/rest/skillsforjira/1/expertise/JIRAUSER10001
  • Response (200):

    Code Block
    languagejs
    {"skillsByUserKey":{"JIRAUSER10100":[{"key":"UseEngineering Case- WritingBeginner","addedAt":16847518990661684751913939,"addedBy":"admin"},{"key":"TestEngineering - PlanningProficient","addedAt":16847518990661684751913939,"addedBy":"admin"},{"key":"TestEngineering - AutomationExpert","addedAt":16847533427241684751913939,"addedBy":"admin"}]

Add user skills

Adds one or more of skills to the specified user.

  • HTTP Method: PUT

  • Request:

    • accountId (query) The account ID of the user. Required

    • skills (body): An array of skills to add. Required

  • Response [JSON]:

    • added: An array of skills that were successfully added

    • existing: An array of skills that the user already had

Example:

  • Request:

    Code Block
    HTTP PUT: https://{your-generated-endpoint-url}?accountId=3e63957f-c263-41cd-acda-748560232d49
    {
      "skills":["Engineering - Beginner","JavaScript", "HTML/CSS"]
    }
  • Response (200):

    Code Block
    {
      "added":["HTML/CSS"],
      "existing":["Engineering - Beginner","JavaScript"]
    }

Remove user skills

Removes one or more skills from the specified user.

  • HTTP Method: DELETE

  • Request:

    • accountId (query) The account ID of the user. Required

    • skills (body): An array of skills to remove. Required

  • Response [JSON]:

    • removed: An array of user’s skills that were successfully deleted

    • missing: An array of skills that the user did not possess

Example:

  • Request:

    Code Block
    HTTP DELETE: https://{your-generated-endpoint-url}?accountId=3e63957f-c263-41cd-acda-748560232d49
    {
      "skills":["HTML/CSS", "Product Discovery"]
    }
  • Response (200):

    Code Block
    {
      "removed":["HTML/CSS"],
      "missing":["Product Discovery"]
    }

Get all users' skills

Returns the mapping of all experts and their skills in your Jira instance

  • HTTP Method: GET

  • Request: None

  • Response [JSON]:

    skillsByAccountId: users / skills mapping
    ,"admin":[{"key":"Use Case Writing","addedAt":1684751899066,"addedBy":"admin"},{"key":"Test Planning","addedAt":1684751899066,"addedBy":"admin"},{"key":"Test Automation","addedAt":1684753342724,"addedBy":"admin"}]},"userKeysBySkillKey":{"Test Automation":["admin"],"Engineering - Beginner":["JIRAUSER10100"],"Engineering - Proficient":["JIRAUSER10100"],"Test Planning":["admin"],"Engineering - Expert":["JIRAUSER10100"],"Use Case Writing":["admin"]}}

Get user skills

Returns all skills of the specified user.

  • GET /rest/skillsforjira/1/expertise/{userKey}

  • Request:

    • userKey (path): Key of the target user. Required

  • Response [JSON]:

    • An array of all skills that the user has expertise in

Example:

  • Request:

    Code Block
    HTTP GET: httpshttp://{your-generated-endpoint-url}your-instance.com/rest/skillsforjira/1/expertise/JIRAUSER10001
  • Response (200):

    { "skillsByAccountId
    Code Block
    languagejs
    [{"key":"Use {
        "3e63957f-c263-41cd-acda-748560232d49": [ "Engineering - Beginner", "JavaScript", "HTML/CSS" ],
        "63314adf8b75455be455c8a0": [ "Marketing - Competent", "Marketing - Expert", "English - Expert", "Social Media Marketing"],
        "61a4ad9cf241500072f37d74": [ "QA - Competent", "Test Automation", "Selenium", "Python" ]
      }
    }

Bulk update users skills

Updates skill sets of multiple users at once

  • HTTP Method: POST

  • Request:

    skillsByAccountId: users / skills mapping
    Case Writing","addedAt":1684751899066,"addedBy":"admin"},{"key":"Test Planning","addedAt":1684751899066,"addedBy":"admin"},{"key":"Test Automation","addedAt":1684753342724,"addedBy":"admin"}]

Add user skills

Adds new skills to the specified user

  • PUT /rest/skillsforjira/1/expertise/{userKey}/add

  • Request:

    • Array of skill keys to add

  • Response [JSON]:\

    changes: all user

    • All users' skill changes after the import is processed

Example:

  • Request:

    Code Block
    HTTP POSTPUT: httpshttp://{your-generated-endpoint-url}
    {
      "skillsByAccountId": {
        "3e63957f-c263-41cd-acda-748560232d49": your-instance.com/rest/skillsforjira/1/expertise/{userKey}/add
    [ "Engineering - Beginner" ],     "63314adf8b75455be455c8a0": [ "Marketing - Expert", "Marketing - Master", "English - Expert", "Social Media Marketing"],
      }
    }React" ]
  • Response (200):

    Code Block
    {
      "changesadmin": {
        "3e63957f-c263-41cd-acda-748560232d49": {
          "added": [],
          "removed": [ "JavaScript"addedSkillKeys":["Engineering - Expert", "HTML/CSSReact" ]
        },
        "63314adf8b75455be455c8a0removedSkillKeys": {
          "added": [ "Marketing - Master" ],
          "removed": [ "Marketing - Competent" ]
        }
      }
    }

Get skill tree with experts

Returns the complete skill tree with a list of experts specified for each skill

...

HTTP Method: GET

...

Remove user skills

Removes skills from the specified user

  • PUT /rest/skillsforjira/1/expertise/{userKey}/remove

  • Request:

    • Array of skill keys to remove

  • Response [JSON]:

    • experts: skill tree with a list of experts specified for each skillAll users' skill changes after the import is processed

Example:

  • Request:

    Code Block
    HTTP GETPUT: httpshttp://{your-generated-endpoint-url}

    Response (200):

    Code Block
    {
      "experts": [
        {
            "key": "f2c4cba9-6082-48c8-b23e-852e101bedbd",
            "type": "category",
            "displayName": "Design",
            "children": [
              {
                  "key": "9935f79d-02d1-4415-a81b-04f9e9dcd7ce",
                  "type": "category",
                  "displayName": "UX"
                  "children": [
                      {
                          "key": "User Flows",
                          "experts": [ "3e63957f-c263-41cd-acda-748560232d49" ]
                      },
                      {
                          "key": "Wireframes",
                          "experts": []
                      },
                      {
                          "key": "Usability Testing",
                          "experts": [ "3e63957f-c263-41cd-acda-748560232d49", "63314adf8b75455be455c8a0" ]
                      }
                  ]
              }
            ]
        }
      ]
    your-instance.com/rest/skillsforjira/1/expertise/{userKey}/remoev
    [ "React", "Java" ]
  • Response (200):

    Code Block
    {"admin":{"addedSkillKeys":[],"removedSkillKeys":["React"]}}