Using the Swagger API Docs view

Use the Swagger API Docs view to explore and interact with the Infor SData API.

Note: The system administrator and users with the appropriate role can access these features. See What are Roles and Secured Actions?

To use Swagger API:

  1. Expand Administration on the navigation bar.
  2. Click Swagger API Docs.
  3. Click Schemes arrow and select HTTP or HTTPS to match the URL.
    Note: If you select the wrong scheme, the process can fail 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 to perform. Based on the selected item, one or more of these are 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. Specify the parameters.
  8. Click Execute to perform the operation.
    Note: If the operation is successful, the information displays in the Response section.
  9. View the ErrorPayload under Models.
    Element Description
    Severity The severity of the diagnosis entry. Possible values:
    • Info: Informational message - do not require any special attention.
    • Warning: Warning message - do 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 do not exist.
    • ApplicationUnavailable: Application exists but is not available.
    • DatasetNotFound: Dataset do not exist.
    • DatasetUnavailable: Dataset exists but is not available.
    • ContractNotFound: Contract do not exist.
    • ResourceKindNotFound: Resource kind do 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 must be set when sdataCode is set to ApplicationDiagnosis.
    Message A friendly message for the diagnosis.
    StackTrace The stack trace for the error. It must 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.