REST API For Multi Cascade



The public API is delivered in v1.25.0 or higher of the add-on.

 

Resources

/rest/idalko-igrid/1.0/multicascade/



Methods






Obtain Multi Cascade Values GET  /rest/idalko-igrid/1.0/multicascade/{multicascadeId}/issue/{issueId}



Returns a list of the levels and respective selected values

template parameters

parameter

value

required

description

parameter

value

required

description

multicascadeId

long

+

id of the Multi Cascade customfield

issueId

long

+

id of the issue





available response representations: 



  • 200 (success) - application/json. Response example: 

    {"issuetype":"10001","user":"admin"}



  • 403 (forbidden). Returned if:

    • the user has no permissions for the specified issue

  • 400 (bad request). Returned if:

    • the specified customfield id exists but it is not a MultiCascade customfield

  • 404 (not found). Returned if:

    • the specified issueId doesn't exist

    • MultiCascade customfield with the specified id does not exist

  • 401 (not authorised)

  • 500 (server error)






Edit Multi Cascade Values PUT  /rest/idalko-igrid/1.0/multicascade/{multicascadeId}/issue/{issueId}



Edit the Multi Cascade data


template parameters

parameter

value

required

description

parameter

value

required

description

multicascadeId

Long

+

id of the Multi Cascade customfield

issueId

Long

+

id of the issue

values

Map<String, String>

+

map of values to update where the key is the level's name to be updated and the value is the name of the selected option



available request body representation: 

{ "issuetype": "3", "issue": "first", "user": "admin" }



available response representations: 

  • 200 (success)

  • 403 (forbidden). Returned if:

    • the user has no permissions for the specified issue

  • 400 (bad request). Returned if:

    • the specified customfield id exists but it is not a MultiCascade customfield

  • 404 (not found). Returned if:

    • the specified issueId doesn't exist

    • MultiCascade customfield with the specified id does not exist

  • 401 (not authorised)

  • 500 (server error)





Reset Multi Cascade Levels PUT  /rest/idalko-igrid/1.0/multicascade/{multicascadeId}/issue/{issueId}/reset



Edit the Multi Cascade data



template parameters



parameter

value

required

description

parameter

value

required

description

multicascadeId

long

+

id of the Multi Cascade customfield

issueId

long

+

id of the issue



available request representation:

["issuetype", "issue"]

Will reset two multicascade fields with identifiers: issuetype and issue


available response representations: 

  • 200 (success)

  • 403 (forbidden). Returned if:

    • the user has no permissions for the specified issue

  • 400 (bad request). Returned if:

    • the specified customfield id exists but it is not a MultiCascade customfield

  • 404 (not found). Returned if:

    • the specified issueId doesn't exist

    • MultiCascade customfield with the specified id does not exist

  • 401 (not authorised)

  • 500 (server error)






Reset All Multi Cascade Levels PUT  /rest/idalko-igrid/1.0/multicascade/{multicascadeId}/issue/{issueId}/resetall



Reset all multicascade levels



template parameters



parameter

value

required

description

parameter

value

required

description

multicascadeId

long

+

id of the Multi Cascade customfield

issueId

long

+

id of the issue




available response representations: 

  • 200 (success)

  • 403 (forbidden). Returned if:

    • the user has no permissions for the specified issue

  • 400 (bad request). Returned if:

    • the specified customfield id exists but it is not a MultiCascade customfield

  • 404 (not found). Returned if:

    • the specified issueId doesn't exist

    • MultiCascade customfield with the specified id does not exist

  • 401 (not authorised)

  • 500 (server error)




Read Level's Options GET  /rest/idalko-igrid/1.0/multicascade/{multicascadeId}/issue/{issueId}/options/{levelName}



Read all available options from the given level

template parameters

parameter

value

required

description

parameter

value

required

description

multicascadeId

Long

+

id of the Multi Cascade customfield

issueId

Long

+

id of the issue

levelName

String

+

name of the level to retrieve the options from



available response representations: 





  • 200 (success) 

    Response example: 



  • 403 (forbidden). Returned if:

    • the user has no permissions for the specified issue

  • 400 (bad request). Returned if:

    • the specified customfield id exists but it is not a MultiCascade customfield

  • 404 (not found). Returned if:

    • the specified issueId doesn't exist

    • MultiCascade customfield with the specified id does not exist

  • 401 (not authorised)

  • 500 (server error)




Read Levels' Names GET  /rest/idalko-igrid/1.0/multicascade/{multicascadeId}/issue/{issueId}/levels



Read the names of all available levels for the given customfield



template parameters

parameter

value

required

description

parameter

value

required

description

multicascadeId

long

+

id of the Multi Cascade customfield

issueId

long

+

id of the issue



available response representations: 

  • 200 (success) 

    Response example: 



  • 403 (forbidden). Returned if:

    • the user has no permissions for the specified issue

  • 400 (bad request). Returned if:

    • the specified customfield id exists but it is not a MultiCascade customfield

  • 404 (not found). Returned if:

    • the specified issueId doesn't exist

    • MultiCascade customfield with the specified id does not exist

  • 401 (not authorised)

  • 500 (server error)