REST API for JD Edwards EnterpriseOne AIS Server

Get Menu Tasks v1

post

/taskauthorization

Receive a list of authorized tasks based on either a task view ID or the task ID and parent ID with in a task view.

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

The input to the task authorization service.

Root Schema : TaskAuthorizationRequest

Type: object

The input to the task authorization service.

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.
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.
level: integer(int32)

Depth of menus returned, up to a value of 3.
parentTaskId: string

Parent Task Id.
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.
taskId: string
taskViewId: string

Task View Id.
token: string

The AIS token, which is required if other authentication methods are not being used.
username: 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."
        },
        "taskViewId":{
            "type":"string",
            "description":"Task View Id."
        },
        "parentTaskId":{
            "type":"string",
            "description":"Parent Task Id."
        },
        "taskId":{
            "type":"string"
        },
        "level":{
            "type":"integer",
            "format":"int32",
            "description":"Depth of menus returned, up to a value of 3."
        }
    },
    "description":"The input to the task authorization service."
}

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

444 Response

Invalid Token

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

500 Response

Server Failed to Process Request

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

Examples

Example Request

The following shows an example of a task review request for all the tasks. The token value is from a prior call to the tokenrequest service to establish a session.

{
  "token" : "0446fnE/TjE3oNapGFsQ16gvO794DONzJYDGXlqC1o7srk=MDE5MDA4ODkzNzk0MTg3MDk5MTIxNTkzNU15RGV2aWNlMTQ4MTc1NTQxNjU1Nw==",
  "deviceName" : "MyDevice",
  "ssoEnabled" : false,
  "includeTimings" : false,
  "allowCache" : true,
  "forceUpdate" : false,
  "setDirtyOnly" : false,
  "taskViewId" : "93",
  "level" : 0
}

Example Response

The following example shows the contents of the response body.

{
  "authorizedTasks" : [ {
    "type" : "00",
    "taskDescription" : "Content Development Tools",
    "taskId" : "93",
    "tasks" : [ {
      "type" : "01",
      "taskDescription" : "Work With Tasks",
      "applicationId" : "P9000",
      "taskId" : "005787e7-af4b-11d3-a276-00104b65be64",
      "parentTaskId" : "93"
    }, {
      "type" : "01",
      "taskDescription" : "Work With Task Relationships",
      "applicationId" : "P9000",
      "taskId" : "005787e8-af4b-11d3-a276-00104b65be64",
      "parentTaskId" : "93"
    }, {
      "type" : "01",
      "taskDescription" : "Task Where Used",
      "applicationId" : "P9000",
      "taskId" : "005787e9-af4b-11d3-a276-00104b65be64",
      "parentTaskId" : "93"
    }, {
      "type" : "01",
      "taskDescription" : "Work With Variants",
      "applicationId" : "P9005",
      "taskId" : "005787ed-af4b-11d3-a276-00104b65be64",
      "parentTaskId" : "93"
    }, {
      "type" : "11",
      "taskDescription" : "Roles UDC",
      "applicationId" : "P0004A",
      "taskId" : "8a816cfa-1d3f-11d4-b88d-006008df06c2",
      "parentTaskId" : "93"
    }, {
      "type" : "01",
      "taskDescription" : "Role Relationships",
      "applicationId" : "P95921",
      "taskId" : "8a816cfe-1d3f-11d4-b88d-006008df06c2",
      "parentTaskId" : "93"
    }, {
      "type" : "01",
      "taskDescription" : "Security Workbench",
      "applicationId" : "P00950",
      "taskId" : "8a816d02-1d3f-11d4-b88d-006008df06c2",
      "parentTaskId" : "93"
    } ]
  } ]
}

Example Task Review Level 0 Output

The following shows an example of a task review request for level 0 tasks. The token used is from a prior call to the tokenrequest service.

{
  "token" : "0446fnE/TjE3oNapGFsQ16gvO794DONzJYDGXlqC1o7srk=MDE5MDA4ODkzNzk0MTg3MDk5MTIxNTkzNU15RGV2aWNlMTQ4MTc1NTQxNjU1Nw==",
  "deviceName" : "MyDevice",
  "ssoEnabled" : false,
  "includeTimings" : false,
  "allowCache" : true,
  "forceUpdate" : false,
  "setDirtyOnly" : false,
  "taskViewId" : "93",
  "parentTaskId" : "93",
  "taskId" : "005787e7-af4b-11d3-a276-00104b65be64",
  "level" : 0
}

Example Response Task Review Level 0 Output

The following example shows the contents of the response body.

{
{
  "authorizedTasks" : [ {
    "type" : "01",
    "taskDescription" : "Work With Tasks",
    "applicationId" : "P9000",
    "iconPath" : "",
    "taskFlowPath" : "",
    "taskId" : "Work With Tasks"
  } ]
}
{
  "authorizedTasks" : [ {
    "type" : "01",
    "taskDescription" : "Work With Task Relationships",
    "applicationId" : "P9000",
    "iconPath" : "",
    "taskFlowPath" : "",
    "taskId" : "Work With Task Relationships"
  } ]
}
{
  "authorizedTasks" : [ {
    "type" : "01",
    "taskDescription" : "Task Where Used",
    "applicationId" : "P9000",
    "iconPath" : "",
    "taskFlowPath" : "",
    "taskId" : "Task Where Used"
  } ]
}
{
  "authorizedTasks" : [ {
    "type" : "01",
    "taskDescription" : "Work With Variants",
    "applicationId" : "P9005",
    "iconPath" : "",
    "taskFlowPath" : "",
    "taskId" : "Work With Variants"
  } ]
}
{
  "authorizedTasks" : [ {
    "type" : "11",
    "taskDescription" : "Roles UDC",
    "applicationId" : "",
    "iconPath" : "",
    "taskFlowPath" : "",
    "taskId" : "Roles UDC"
  } ]
}
{
  "authorizedTasks" : [ {
    "type" : "01",
    "taskDescription" : "Role Relationships",
    "applicationId" : "P95921",
    "iconPath" : "",
    "taskFlowPath" : "",
    "taskId" : "Role Relationships"
  } ]
}
{
  "authorizedTasks" : [ {
    "type" : "01",
    "taskDescription" : "Security Workbench",
    "applicationId" : "P00950",
    "iconPath" : "",
    "taskFlowPath" : "",
    "taskId" : "Security Workbench"
  } ]
}
}