ScriptProviderHibernateImpl Resource

The base provider. All providers should have similar functionality to this. Hopefully these methods are fairly self-explanatory. Think of these as 'tool box' functions to help generate services quickly.

GET /script/getScriptById/{id}

Get a gds script by id

Request Parameters
name type description constraints
id path long
Response Body
media type data type description
application/json GdsScript (JSON)
application/xml gdsScript (XML)

Example

Request
GET /script/getScriptById/{id}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "id" : 12345,
  "location" : "...",
  "description" : "...",
  "name" : "...",
  "date" : 12345
}
                
              

POST /script/getScriptGrid/{config}

Get scripts in grid format.

Request Parameters
name type description
config path
list query
Response Body
media type data type description
application/json GdsScriptGrid (JSON)
application/xml gdsScriptGrid (XML)

Example

Request
POST /script/getScriptGrid/{config}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "rows" : [ {
    "id" : 12345,
    "name" : "...",
    "location" : "...",
    "description" : "...",
    "date" : 12345
  }, {
    "id" : 12345,
    "name" : "...",
    "location" : "...",
    "description" : "...",
    "date" : 12345
  } ],
  "total" : 12345,
  "page" : 12345,
  "records" : 12345,
  "rowIds" : [ 12345, 12345 ]
}
                
              

DELETE /script/removeScript/{scriptId}

Remove a gds script

Request Body
media type data type
application/json number (JSON)
application/xml long (XML)

Example

Request
DELETE /script/removeScript/{scriptId}
Content-Type: application/json

                
...
                
              
Response
HTTP/1.1 204 No Content

              

POST /script/saveScript/{script}

Save a script database entry

Request Body
media type data type
application/json GdsScript (JSON)
application/xml gdsScript (XML)
Response Body
media type data type description
application/json GdsScript (JSON) saved gds script
application/xml gdsScript (XML)

Example

Request
POST /script/saveScript/{script}
Content-Type: application/json
Accept: application/json

                
{
  "id" : 12345,
  "location" : "...",
  "description" : "...",
  "name" : "...",
  "date" : 12345
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "id" : 12345,
  "location" : "...",
  "description" : "...",
  "name" : "...",
  "date" : 12345
}