Jump to

• Request
• Response
• Examples

Discover Details of a Business Function v2

post

/jderest/v2/bsfnservice/discover

Discover the data structure for a business function.

Request

Supported Media Types

• application/json

Header Parameters

• jde-AIS-Auth(optional): string
  Token
• jde-AIS-Auth-Device(optional): string
  Device Name
• jde-AIS-MonitorOnStart(optional): boolean
  Monitor on Start
• jde-AIS-MonitorRequest(optional): string
  Monitor Request

  Allowed Values: [ "monitorRequest", "monitorRequestIO" ]

Body ()

The input to a Business Function discover request.

Root Schema : DiscoverBSFNRequest

Type: object

The input to a Business Function discover request.

Show Source

• deviceName(optional): string
  An identifier for the device making the service call. If not provided, the requesting IP address is used.
• environment(optional): string
  Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
• jasserver(optional): string
  The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used.
• name(optional): string
  The unique name of the Business Function to discover, for example RetrieveCompanyFromBusUnit.
• objectName(optional): string
  The object name of the Business Functions to discover, for example B0000130. This will discover all business functions in the object.
• password(optional): string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• psToken(optional): string
  Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
• returnDetail(optional): boolean
  Specify to return all the inputs and output definitions for each of the discovered Business Functions
• role(optional): string
  The role to use for login. If not specified, the default role configured for the AIS Server will be used.
• systemCode(optional): string
  The system code of the Business Functions to discover, for example 09. This will discover all business functions in the system code.
• template(optional): string
  The data structure for the Business Functions to discover, for example D0000130. This will discover all busoiness functions that use this data structure
• token(optional): string
  The AIS token, which is required if other authentication methods are not being used.
• username(optional): string
  JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.

{
    "type":"object",
    "properties":{
        "environment":{
            "type":"string",
            "description":"Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used."
        },
        "role":{
            "type":"string",
            "description":"The role to use for login. If not specified, the default role configured for the AIS Server will be used."
        },
        "jasserver":{
            "type":"string",
            "description":"The HTML (JAS) Server to use for login. If not specified, the default HTML Server configured for the AIS Server will be used."
        },
        "token":{
            "type":"string",
            "description":"The AIS token, which is required if other authentication methods are not being used."
        },
        "deviceName":{
            "type":"string",
            "description":"An identifier for the device making the service call. If not provided, the requesting IP address is used."
        },
        "psToken":{
            "type":"string",
            "description":"Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server."
        },
        "username":{
            "type":"string",
            "description":"JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used."
        },
        "password":{
            "type":"string",
            "description":"The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used."
        },
        "name":{
            "type":"string",
            "description":"The unique name of the Business Function to discover, for example RetrieveCompanyFromBusUnit."
        },
        "template":{
            "type":"string",
            "description":"The data structure for the Business Functions to discover, for example D0000130. This will discover all busoiness functions that use this data structure"
        },
        "objectName":{
            "type":"string",
            "description":"The object name of the Business Functions to discover, for example B0000130. This will discover all business functions in the object."
        },
        "systemCode":{
            "type":"string",
            "description":"The system code of the Business Functions to discover, for example 09. This will discover all business functions in the system code."
        },
        "returnDetail":{
            "type":"boolean",
            "description":"Specify to return all the inputs and output definitions for each of the discovered Business Functions"
        }
    },
    "description":"The input to a Business Function discover request."
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful Execution

400 Response

Bad Request - Invalid JSON Input

403 Response

Authorization Failure

415 Response

Invalid Content-Type Header - Must use application/json

500 Response

Server Failed to Process Request

Body ()

Root Schema : ServiceErrorResponse

Type: object

Error Response

Show Source

• errorText(optional): string
• exception(optional): string
  The class of the exception if an exception was thrown.
• exceptionId(optional): string
  ExceptionId, only if an exception record was written to the F980060
• message(optional): string
  Details about the error.
• status(optional): string
  Allowed Values: [ "ERROR", "WARNING" ]

  Status determined by exception handling
• timeStamp(optional): string
  The timestamp indicating the time the error message was returned.
• type(optional): string
  Optional type of error
• userDefinedErrorText(optional): string
  Optional error text added to an orchestration step.

{
    "type":"object",
    "properties":{
        "message":{
            "type":"string",
            "description":"Details about the error."
        },
        "exception":{
            "type":"string",
            "description":"The class of the exception if an exception was thrown."
        },
        "timeStamp":{
            "type":"string",
            "description":"The timestamp indicating the time the error message was returned."
        },
        "userDefinedErrorText":{
            "type":"string",
            "description":"Optional error text added to an orchestration step."
        },
        "type":{
            "type":"string",
            "description":"Optional type of error"
        },
        "errorText":{
            "type":"string"
        },
        "exceptionId":{
            "type":"string",
            "description":"ExceptionId, only if an exception record was written to the F980060"
        },
        "status":{
            "type":"string",
            "description":"Status determined by exception handling",
            "enum":[
                "ERROR",
                "WARNING"
            ]
        }
    },
    "description":"Error Response"
}

Back to Top

Examples

Example Request

Use the business function discovery service to get the details of an EnterpriseOne business function. Business functions are uniquely identified by their name. There may be multiple functions for an individual OMW object (Bxxxxxx), so they are returned as an array. The token value is from a prior call to the token request service to establish a session.

curl -i -X POST -H "Content-Type:application/json" http://ais_server_url/jderest/v2/bsfnservice/discover -d
{
    "token" : "044JHa5ZJWbI8PeLalEJFL8pU3VEWKJ17kotDHvwf5mFqc=MDE5MDA4OTE4MDAyNzQ2ODg2NDM2NTUxMk15RGV2aWNlMTQ3ODY0MjUyNjYzMw==",
    "objectName" : "B0000130",
    "returnDetail": true 
}

Example Response

The following example shows the contents of the response body.

{
    "functions": [
        {
            "objectName": "B0000130",
            "name": "RetrieveCompanyFromBusUnit",
            "description": "F0006 Get Company from Business Unit",
            "systemCode": "09",
            "source": "C",
            "parentDll": "CFIN",
            "location": "2",
            "template": "D0000130",
            "dataStructureDetail": [
                {
                    "controlId": 1,
                    "description": "Business Unit (MCU0)",
                    "datatype": 2,
                    "name": "szCostCenter",
                    "ddItem": "MCU0",
                    "ioType": 0,
                    "required": false
                },
                {
                    "controlId": 2,
                    "description": "Company (CO)",
                    "datatype": 2,
                    "name": "szCompany",
                    "ddItem": "CO",
                    "ioType": 0,
                    "required": false
                },
                {
                    "controlId": 3,
                    "description": "Description (DL01)",
                    "datatype": 2,
                    "name": "szCostCenterDescription",
                    "ddItem": "DL01",
                    "ioType": 0,
                    "required": false
                }
            ]
        }
    ]
}

Back to Top