WOLFRAM

Wolfram Language & System Documentation Center

"WolframApplicationServer" (Service Connection)

Connect to a Wolfram Application Server with the Wolfram Language to call deployed applications.

Connecting & Authenticating

ServiceConnect["WolframApplicationServer",server] creates a connection to the specified Wolfram Application Server.

Requests

ServiceExecute[ServiceObject["WolframApplicationServer",...],"request",params] sends a request to the Wolfram Application Server API, using parameters params. The following give possible requests.

Information

Requests:

"Services" — a list of services available on the provided Wolfram Application Server, returned as URLs

"ServiceDeployments" — a list of services available on the provided Wolfram Application Server, returned as ServiceDeployment

Requests:

"ServiceInformation" — information concerning the provided service

Parameters:
  • "Service"(required)the name or URL for the service
    • Requests:

    "EndpointInformation" — information concerning the provided endpoint path

    Parameters:
  • "Endpoint"(required)the relative path or URL for an endpoint
    • Requests:

    "Resources" — a list of resources available on the provided Wolfram Application Server, returned as URLs

    Requests:

    "ResourceContents" — the expression evaluated when calling the provided resource

    "ResourceInformation" — information concerning the provided resource path

    Parameters:
  • "Resource"(required)the relative path or URL for a resource
    • Requests:

    "NodeFiles" — a list of files available on the provided Wolfram Application Server, returned as URLs

    Requests:

    "NodeFileContents" — the contents of the provided files

    Parameters:
  • "NodeFile"(required)the relative path or URL for a node file

    • Deployment

    Requests:

    "DeployNodeFile" — upload a new file to the Wolfram Application Server, returns a URL to the file

    Parameters:
  • "NodeFile"(required)the relative path or URL for the file
    "Contents"(required)the content of the file, can be an expression or file specified by a file path or File
    • Requests:

    "DeployResource" — create or update a resource on the Wolfram Application Server, returns a URL to the resource

    Parameters:
  • "Resource"(required)the relative path or URL for the resource
    "Contents"(required)the content of the resource, can be an expression or package file specified by a file path or File
    "ResourceType"Automaticdetermines the server behavior when accessing the resource
    "MIMEType"Automatictype of file used for the resource
    "PoolName"Automaticname of the kernel pool used to evaluate the resource
    "Timeout"Nonethe kernel evaluation time limit used when evaluating the resource, can be expressed as a Quantity or number of seconds
    • Requests:

    "DeployEndpoint" — create or update an endpoint on the Wolfram Application Server, returns a URL to the endpoint

    Parameters:
  • "Endpoint"(required)the relative path or URL for the endpoint
    "Resource"(required)the relative path or URL for the resource used when calling the endpoint

    • Deletion

    Requests:

    "DeleteResource" — removes the specified resource from the Wolfram Application Server

    Parameters:
  • "Resource"(required)the relative path or URL for the resource
    • Requests:

    "DeleteEndpoint" — removes the specified endpoint from the Wolfram Application Server

    Parameters:
  • "Endpoint"(required)the relative path or URL for the endpoint
    • Requests:

    "DeleteNodeFile" — removes the specified file from the Wolfram Application Server

    Parameters:
  • "NodeFile"(required)the relative path or URL for the file

    • Resources

    Creation

    Create a new resource:

    Wolfram Language code: was["DeployResource", <|"Resource" -> "resources/hello.wl", "Contents" -> APIFunction[{"name" -> "String"}, StringJoin[{"Hello ", #name, "!"}]&]|>]

    Information

    List the available resources:

    Wolfram Language code: was["Resources"]

    Get more information on a specific resource:

    Wolfram Language code: was["ResourceInformation", "Resource" -> URL["http://resources.was.example.com/packages/hello.wl"]]

    Get the contents of a specific resource:

    Wolfram Language code: was["ResourceContents", "Resource" -> "resources/hello.wl"]

    Deletion

    Delete a specific resource:

    Wolfram Language code: was["DeleteResource", "Resource" -> "resources/hello.wl"]

    Endpoints

    Creation

    Create a new endpoint:

    Wolfram Language code: was["DeployEndpoint", {"Endpoint" -> "hello", "Resource" -> "resources/hello.wl"}]

    Information

    Get more information on a specific endpoint:

    Wolfram Language code: was["EndpointInformation", "Endpoint" -> URL["http://endpoints.was.example.com/hello"]]

    Deletion

    Delete a specific endpoint; this will leave the resource untouched:

    Wolfram Language code: was["DeleteEndpoint", "Endpoint" -> "hello"]

    Node Files

    Creation

    Create a new file that is stored on each node of the WAS instance:

    Wolfram Language code: file = CreateFile[]; Export[file, "f = StringJoin[{\"Hello \", #1}] & ", "String"]
    Wolfram Language code: was["DeployNodeFile", <|"NodeFile" -> "packages/hello.wl", "Contents" -> file|>]

    Information

    List the available packages:

    Wolfram Language code: packages = was["NodeFiles"]

    Get the contents of a specific package:

    Wolfram Language code: was["NodeFileContents", "NodeFile" -> URL["http://nodefiles.was.example.com/packages/hello.wl"]]

    See the contents of a specific package:

    Wolfram Language code: Import[First[packages], "String"]

    Deletion

    Delete a specific package:

    Wolfram Language code: was["DeleteNodeFile", "NodeFile" -> "packages/hello.wl"]

    Examples

    Basic Examples  (1)

    Create a new connection:

    Wolfram Language code: was = ServiceConnect["WolframApplicationServer", "http://was.example.com"]

    List the available services:

    Wolfram Language code: was["Services"]

    Get more information on a specific service:

    Wolfram Language code: was["ServiceInformation", "Service" -> URL["http://was.example.com/hello"]]

    Clicking the link provided will open it in a new browser tab: