Page Comparison

...

Expand

title	Get information for all the tables (GET)

METHOD

URL

Data

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
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

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

title	Delete an existing row in a table (DELETE)

METHOD	URL	Data
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

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 }

...

Useful Methods

Expand

title	Import packages

Code Block
import org.apache.log4j.Logger; import org.apache.log4j.Level; import groovyx.net.http.HTTPBuilder import static groovyx.net.http.ContentType.* import static groovyx.net.http.Method.*

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)
        }
    }
}

Expand

title	Send POST request with data

Code Block

def sendPostRequest(url, bodyData) {
    def log = Logger.getLogger("LookupManager")
    log.setLevel(Level.DEBUG)
    
    def json = new groovy.json.JsonBuilder()

    //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(POST) {
        headers.
        'Authorization' = "Basic " + ((userName + ":" + password).bytes.encodeBase64().toString())
        headers.
        'X-Atlassian-Token' = 'no-check';
        requestContentType = URLENC
        body = "data=" + bodyData


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

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

Expand

title	Send PUT request with data

Code Block

def sendPostRequestsendPutRequest(url, bodyData) {
    def log = Logger.getLogger("LookupManager")
    log.setLevel(Level.DEBUG)
    
    def json = new groovy.json.JsonBuilder()

    //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(PUT) {
        headers.
        'Authorization' = "Basic " + ((userName + ":" + password).bytes.encodeBase64().toString())
        headers.
        'X-Atlassian-Token' = 'no-check';
        requestContentType = URLENC
        body = bodyData


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

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

...

Versions Compared

Old Version 3

New Version Current

Key

Table row

Table Column

Useful Methods