WebSphere Business Monitor, Version 6.2 Operating Systems: AIX, HP-UX, Linux, Solaris, Windows


Model - User-defined Functions (UDFs) Resource - GET Method

Resource URI

GET /models/{model id}/versions/{version}/udfs

Parameters

None.

Request Content

None.

Response Content

The default content-type is application/json.

MIME Type: application/json

The following table lists all parameters in the JSON output:

Parameter Name

Type

Description

Model ID

string

The monitor model ID

Version

integer

The monitor model version

UDF Array

array

 

 

UDF Namespace

string

UDF namespace

 

UDF Prefix

string

UDF prefix

 

UDF Function Array

array

 

 

 

UDF Name

string

UDF name

 

 

Signature Array

array

 

 

 

 

Output Type

string

UDF output type

 

 

 

Signature Long Description

string

UDF Signatures description and parameters

 

 

 

Parameter Array

array

Array of parameters

 

 

 

 

Parameter Type

string

A parameter data type

 


+ View Schema
{ "description": "User Defined Function List", 
  "type": "object",
  "properties":
	{   "Model ID":{"type":"string"},
	    "Version" :{"type":"integer"},
	    "UDF Array":[
		"UDF Prefix":{"type":"string"},
		"UDF Namespace":{"type":"string"},
		"UDF Function Array": [
           			 {
              			 	"UDF Name":{"type":"string"},
              			 	"Signature Array":[
                 			 	{
                    			 	"Signature Long Description":{"type":"string"},
                     			 	"Output Type":{"type":"string"},
                    			 	"Parameter Array":[
                        			 	{
                           			   	"Parameter Type":{"type":"string"}
                       				 	}
                     					   	  ]
                  			 	}
               					   	  ]
           			 }				      
					]
			]
	}
}

Example content:

{
   "Model ID":"OrderItem",
   "Version":20060803000000,
   "UDF Array":[
      {
         "UDF Prefix":"",
         "UDF Namespace":"",
         "UDF Function Array":[
            {
               "UDF Name":"add-dayTimeDuration-to-date",
               "Signature Array":[
                  {
                     "Signature Long Description":"",
                     "Output Type":"xs:date",
                     "Parameter Array":[
                        {
                           "Parameter Type":"xs:date"
                        },
                        {
                           "Parameter Type":"xs:duration"
                        }
                     ]
                  }
               ]
            },
            {
               "UDF Name":"add-dayTimeDuration-to-dateTime",
               "Signature Array":[
                  {
                     "Signature Long Description":"",
                     "Output Type":"xs:dateTime",
                     "Parameter Array":[
                        {
                           "Parameter Type":"xs:dateTime"
                        },
                        {
                           "Parameter Type":"xs:duration"
                        }
                     ]
                  }
               ]
            }
	}
   ]
}

Error Response Content

Detailed error information.

The default content-type is application/json.

MIME Type: application/json


+ View Schema
{ "description": "REST error response", 
  "type": "object",
  "properties":
   { "Status Code" : {"type":"integer"},
     "Error" : {"type":"string"},
   }
} 

Status Codes

The method returns one of the following status codes:
CodeDescription
200 OK
Successful completion - requested data returned. Note that the list may be empty.
403 Forbidden
Not authorized to request the resource.
404 Not Found
Resource not found or URL not supported.
400 Bad Request
The request contains invalid parameters or is missing parameters and inputs.
500 Internal Server Error
Internal error processing the request.

Available Since

6.1

Parent Topic: User-defined Functions (UDFs) Resource