Jump to

• Request
• Response
• Examples

Execute an EnterpriseOne Business Function

post

/v2/bsfnservice

Request

Supported Media Types

• application/json

Header Parameters

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

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

Body ()

The input to a Business Function service request.

Root Schema : BSFNRequest

Type: object

The input to a Business Function service request.

Show Source

• deviceName: string
  An identifier for the device making the service call. If not provided, the requesting IP address is used.
• environment: string
  Specify the environment to use for login. If not specified, the default environment configured for the AIS Server will be used.
• inParams(required): array inParams
  The parameters to pass into the business function based on the data structure id's and values
• isAsynch: boolean
  Specify that the Business Function call should be asynchronous or not.
• jasserver: 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(required): string
  The unique Business Function name to execute, for example RetrieveCompanyFromBusUnit.
• outputIds: array outputIds
  The parameters to return from the business function based on the data structure id's
• password: string
  The JD Edwards EnterpriseOne password, which is required if other authentication methods are not being used.
• psToken: string
  Used for logging in with psToken. Primarily used by the HTML Server to establish a session with the AIS Server.
• role: string
  The role to use for login. If not specified, the default role configured for the AIS Server will be used.
• token: string
  The AIS token, which is required if other authentication methods are not being used.
• transactionId: string
  The transaction id to attach to.
• username: string
  JD Edwards EnterpriseOne username, which is required if other authentication methods are not being used.

{
    "type":"object",
    "required":[
        "inParams",
        "name"
    ],
    "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 Business Function name to execute, for example RetrieveCompanyFromBusUnit."
        },
        "isAsynch":{
            "type":"boolean",
            "description":"Specify that the Business Function call should be asynchronous or not."
        },
        "transactionId":{
            "type":"string",
            "description":"The transaction id to attach to."
        },
        "inParams":{
            "type":"array",
            "description":"The parameters to pass into the business function based on the data structure id's and values",
            "items":{
                "$ref":"#/definitions/DSTRInputValue"
            }
        },
        "outputIds":{
            "type":"array",
            "description":"The parameters to return from the business function based on the data structure id's",
            "items":{
                "type":"integer",
                "format":"int64"
            }
        }
    },
    "description":"The input to a Business Function service request."
}

Nested Schema : inParams

Type: array

The parameters to pass into the business function based on the data structure id's and values

Show Source

• Array of: object DSTRInputValue
  A data structure id and value pair to use for this execution of the business function.

{
    "type":"array",
    "description":"The parameters to pass into the business function based on the data structure id's and values",
    "items":{
        "$ref":"#/definitions/DSTRInputValue"
    }
}

Nested Schema : outputIds

Type: array

The parameters to return from the business function based on the data structure id's

Show Source

• Array of: integer(int64)

{
    "type":"array",
    "description":"The parameters to return from the business function based on the data structure id's",
    "items":{
        "type":"integer",
        "format":"int64"
    }
}

Nested Schema : DSTRInputValue

Type: object

A data structure id and value pair to use for this execution of the business function.

Show Source

• id(required): integer(int64)
  The ID of the business function parameter to set, defined in the data structure template.
• value(required): string
  The value to use for the business function parameter with the associated id.

{
    "type":"object",
    "required":[
        "id",
        "value"
    ],
    "properties":{
        "id":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the business function parameter to set, defined in the data structure template."
        },
        "value":{
            "type":"string",
            "description":"The value to use for the business function parameter with the associated id."
        }
    },
    "description":"A data structure id and value pair to use for this execution of the business function."
}

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: string
• exception: string
  The class of the exception if an exception was thrown.
• exceptionId: string
  ExceptionId, only if an exception record was written to the F980060
• message: string
  Details about the error.
• status: string
  Allowed Values: [ "ERROR", "WARNING" ]

  Status determined by exception handling
• timeStamp: string
  The timestamp indicating the time the error message was returned.
• type: string
  Optional type of error
• userDefinedErrorText: 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 service to execute an EnterpriseOne business function. Business functions are uniquely identified by their name, which is a required input to this service. 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 -d
{
    "token" : "044JHa5ZJWbI8PeLalEJFL8pU3VEWKJ17kotDHvwf5mFqc=MDE5MDA4OTE4MDAyNzQ2ODg2NDM2NTUxMk15RGV2aWNlMTQ3ODY0MjUyNjYzMw==",
    "name": "RetrieveCompanyFromBusUnit",
    "isAsync" : false,
    "inParams" : [
        {
            "id": 1,
            "value" : "30"
        }
    ],
    "outputIds" : [
        2,3
    ]
}

Example Response

The following example shows the contents of the response body.

{
    "name": "RetrieveCompanyFromBusUnit",
    "template": "D0000130",
    "submitted": true,
    "result": {
        "output": [
            {
                "id": 2,
                "value": "00001"
            },
            {
                "id": 3,
                "value": "Eastern Distribution Center"
            }
        ]
    }
}

Back to Top