Using the Swagger API Docs View

Use the Swagger API Docs view to explore and interact with the Infor CloudSuite SData API.
Note: The system administrator and users with the appropriate role can access these features.

To use Swagger API

  1. On the Navigation bar expand Administration.
  2. Click Swagger API Docs.
  3. Click the Schemes drop-down arrow and select HTTP or HTTPS to match the URL

    If you select the wrong scheme, the execution can be failed when testing API data.

  4. Expand one of these fields:
    Resource Collection
    Retrieve a collection of records based on specified parameters.
    Create
    Creates a new resource.
    $template
    • Resource Template
    • Service Operation Template Request
    Single Resource
    Retrieve a record based on an ID
    Update
    Updates an existing resource
    Delete
    Deletes an existing resource
    Resource Property
    Retrieve a single property of a resource
    Service Option
    Create a new business rule or retrieve results of a business rule
    Batch
    Create a new batch operation.
    Named Query
    Create a new query or retrieve the results of a named query.
  5. Click the operation method you want to perform. Depending upon the selected item, one or more of the following will be available:
    • GET – Retrieves results based on the specified parameters.
    • POST – Creates a new resource.
    • PUT – Updates an existing resource.
    • DELETE – Deletes an existing resource.
  6. Click Try it out.
  7. Complete the parameters.
  8. Click Execute to perform the operation.

    If the operation is successful, the information displays in the Response section.

  9. Under Models you can view the ErrorPayload.
    Element Description
    severity The severity of the diagnosis entry. Possible values are:
    • Info: Informational message - does not require any special attention.
    • Warning: Warning message - does not prevent operation from succeeding but may require attention.
    • Transient: Transient error - operation failed but may succeed later in the same condition (record locked for 'xxx').
    • Error: Error: Operation failed - request should be modified before resubmitting.
    • Fatal: Severe error – The operation should not be reattempted. Other operations are likely to fail too.
    sdataCode The SData diagnosis code
    • BadUrlSyntax: Invalid URL syntax.
    • BadQueryParameter: Invalid Query Parameter.
    • ApplicationNotFound: Application does not exist.
    • ApplicationUnavailable: Application exists but is not available.
    • DatasetNotFound: Dataset does not exist.
    • DatasetUnavailable: Dataset exists but is not available.
    • ContractNotFound: Contract does not exist.
    • ResourceKindNotFound: Resource kind does not exist.
    • BadWhereSyntax: Invalid syntax for a where condition.

    • ApplicationDiagnosis: Application specific diagnosis, detail is in the applicationCode element.
    applicationCode The application specific diagnosis code. This should only be set when sdataCode is set to ApplicationDiagnosis.
    message A friendly message for the diagnosis.
    stackTrace The stack trace for the error. It should only be filled when the service is run in “development” mode.
    payloadPath XPath expression that refers to the payload element responsible for the error. This element is only used when the error is related to a specific piece of data being sent to the service provider. For example when updating a resource, or when submitting a service request.
Parent topic: Integrations