Page Comparison

...

Expand

title	Get information for all the tables (GET)

METHOD

URL

Data

Sample Code

GET

/rest/lookuprestresource/1.0/lookup/table

Return an array of table information

Example

Code Block
[ { "columns":[ { "id":4, "name":"Application" }, { "id":5, "name":"App Owner" } ], "name":"App Mapping", "id":2 } ]

Sample code

Code Block
//Get information for all the tables def data = sendGetRequest("/rest/lookuprestresource/1.0/lookup/table/") data.each{val -> //TODO }

Expand

title	Add a new table (POST)

METHOD	URL	Data

...

POST

/rest/lookuprestresource/1.0/lookup/table

The data should be a valid JSON string containing the following information:

Name of the new table
Columns name of the new table

Example

Code Block
{ "name":"New_Table", "columns": ["Column_1, Column_2"] }

Sample code

Code Block

def bodyData = 'data={"name":"New_Table","columns":["Column_1","Column_2"]}'
def responseData = sendPostRequest("/rest/lookuprestresource/1.0/lookup/table",bodyData)
//{columns=[{id=22, name=Column_1}, {id=23, name=Column_2}], name=New_Table, id=11}

Expand

title	Update an existing table (PUT)

METHOD	URL	Data

...

PUT

/rest/lookuprestresource/1.0/lookup/table/{TABLE_NAME}

The data should be a valid JSON string containing the following information:

Name of the table
Columns name of the table
Mode of the action
- append: Add the entries to the existing table. New table will be created if no existing table is found
- overwrite: Remove the existing table and add the entries
Entries of the table
- The first entry must be the column names

Example

Code Block
{ "name":"New_Table", "columns": ["Column_1, Column_2"], "mode": "overwrite", "result":[["Column_1","Column_2"],["admin","This is a message"]] }

Sample code

Code Block

def bodyData = '{"name":"New_Table","columns":["Column_1","Column_2"],"mode":"overwrite","result":[["Column_1","Column_2"],["admin","This is a message"]]}';
def responseData = sendPutRequest("/rest/lookuprestresource/1.0/lookup/table/New_Table",bodyData)

Expand

title	Delete an existing table (DELETE)

METHOD	URL	Data

...

Sample Code

DELETE

/rest/lookuprestresource/1.0/lookup/table/{TABLE_ID}

-

Sample code

Code Block
//Delete the data for table id 2 sendDeleteRequest("/rest/lookuprestresource/1.0/lookup/table/2")

Table row

Expand

title	Get rows information for a table (GET)

METHOD

URL

Data

Sample Code

GET

/rest/lookuprestresource/1.0/lookup/table/{TABLE_ID}/entries

Return the an array of rows information for a table

Example

Code Block
[ { "4":"Confuence", "5":"Leon", "id":7, "tableid":2 }, { "4":"Jira", "5":"admin", "id":15, "tableid":2 } ]

Sample code

Code Block
//Get the rows information for table id 2 def data = sendGetRequest("/rest/lookuprestresource/1.0/lookup/table/2/entries") data.each{val -> //TODO }

expand/rest/lookuprestresource/

Sample code

Expand

title	Add a new row in a table (POST)

METHOD

URL

Data

Sample Code

POST

/rest/lookuprestresource/1.0/lookup/table/{TABLE_ID}/entries

The row data should be a valid JSON string containing the following information:

KEY: column id
VALUE: cell data

Example

Code Block
{ "4":"Jira 8", "5":"admin" }

Code Block

def bodyData = 'data={"4":"Jira 8","5":"admin"}'
def responseData = sendPostRequest("/rest/lookuprestresource/1.0/lookup/table/2/entries", bodyData)
//Sample responseData: {4=Jira, 5=admin, id=20, tableid=2}

title	Update an existing row in a table (PUT)

METHOD

URL

Data

Sample Code

PUT

Code Block

def bodyData = 'data={"4":"Jira 8","5":"admin"}'
def responseData = sendPostRequest("/rest/lookuprestresource/1.0/lookup/table/2/entries", bodyData)
//Sample responseData: {4=Jira, 5=admin, id=20, tableid=2}

Expand

title	Update an existing row in a table (PUT)

METHOD

URL

Data

PUT

/rest/lookuprestresource/1.0/lookup/table/{TABLE_ID}/entries/{ROW_ID}

The data should be a valid JSON string containing the following information:

KEY: column id
VALUE: cell data

Example

Code Block
{ "4":"Jira", "5":"admin1" }

Sample code

Code Block

//Update the data for row id 20
def bodyData = 'data={"4":"Jira","5":"admin1"}'
def responseData = sendPutRequest("/rest/lookuprestresource/1.0/lookup/table/2/entries/20",bodyData)
//Sample responseData: {4=Jira, 5=admin1, id=20, tableid=2}

Expand

title	Delete an existing row in a table (DELETE)

METHOD	URL	Data	Sample Code
DELETE	/rest/lookuprestresource/1.0/lookup/table/{TABLE_ID}/entries/{ROW_ID}

Sample code

Code Block
//Delete the data for row id 20 sendDeleteRequest("/rest/lookuprestresource/1.0/lookup/table/2/entries/20")

Table Column

Expand

title	Get columns information for a table (GET)

METHOD

URL

Data

Sample Code

GET

/rest/lookuprestresource/1.0/lookup/table/{TABLE_ID}/columns

Return the columns information for a table

Example

Code Block
{ "columns":[ { "id":4, "name":"Application" }, { "id":5, "name":"App Owner" } ], "name":"App Mapping", "id":2 }

Sample code

Code Block
//Get the columns information for table id 2 def data = sendGetRequest("/rest/lookuprestresource/1.0/lookup/table/2/columns") data.each{val -> //TODO }

Expand

title	Add a new column in a table (POST)

METHOD

URL

Data

Sample Code

POST

/rest/lookuprestresource/1.0/lookup/table/{TABLE_ID}/column

The column name

Example:

Code Block
COLUMN_NAME

Sample code

Code Block
def bodyData = 'columnName=COLUMN_NAME' def responseData = sendPostRequest("/rest/lookuprestresource/1.0/lookup/table/2/column",bodyData)

Expand

title	Update an existing column in a table (PUT)

METHOD

URL

DataSample Code

PUT

/rest/lookuprestresource/1.0/lookup/table/{TABLE_ID}/column/{COLUMN_ID}

The new column name

Example:

Code Block
NEW_COLUMN_NAME

Sample code

Code Block
def bodyData = 'newColumnName=NEW_COLUMN_NAME' def responseData = sendPutRequest("/rest/lookuprestresource/1.0/lookup/table/2/column/6",bodyData)

Expand

title	Delete an existing column in a table (DELETE)

METHOD	URL	DataSample Code
DELETE	/rest/lookuprestresource/1.0/lookup/table/{TABLE_ID}/column/{COLUMN_ID}	-

Sample code

Code Block
def responseData = sendDeleteRequest("/rest/lookuprestresource/1.0/lookup/table/2/column/6")

Useful Methods

Expand

title	Send GET request

Code Block

def sendGetRequest(url) {
    def log = Logger.getLogger("LookupManager")
    log.setLevel(Level.DEBUG)

    //Step 1: Set base URL, E.g. http://localhost:2990/jira
    def baseUrl = "http://localhost:2990/jira";

    //Step 2: Set username and password
    def userName = "admin"
    def password = "admin"

    def http = new HTTPBuilder(baseUrl + url)
    http.request(GET) {
        headers.
        'Authorization' = "Basic " + ((userName + ":" + password).bytes.encodeBase64().toString())
        headers.
        'X-Atlassian-Token' = 'no-check';
        requestContentType = URLENC

        response.success = {resp, data ->
            log.debug("SUCCESS: " + resp.status)
            log.debug(data)
        }

        response.failure = { resp,data ->
            log.error("ERROR: " + resp.status)
            log.error(data)
        }
    }
}

...

Versions Compared

Old Version 2

New Version 3

Key

Table row

Table Column

Useful Methods