Learn more

What options can I use to invoke cURL?

This table summarizes the cURL options used in the command examples. For example, here's how a code line would look like in cURL:

curl -i -X POST -H Authorization: Bearer <token copied from the 'Get a token for authentication' section> <request-header>:<value> https://hs-umt-scim.oracleindustry.com/<resource-path>

cURL Option	Description
-d, --data @file.json	Identifies the file that contains the request body, in JSON format, on the local machine. Alternatively, you can pass the request body with -d"{id=5,status='OK'}.
-F, --form @file.json	Identifies form data, in JSON format, on the local machine.
-H --header, -I -include, and -X --request <method>	Defines one or both of the following: Content type of the request document
-i	Displays response header information.
-X	Indicates the type of request (for example, GET, POST).

What are some examples of API requests for Oracle InForm User Management Tool?

After you set up your REST client, you can send a request to ensure that your connection works. For example, suppose you want to terminate a user using the PATCH method. You can use the following request:

{
   "schemas":[
      "urn:ietf:params:scim:schemas:core:2.0:User",
      "urn:umt:extension:schema:user"

   ],
  "username": "testUserName",
  "active": false
}

If the request is successful, then you should receive a 200 response.

Do I have to request a token every time I need to make an API call?

No, you don't have to request a new token every time you make an API call. However, do keep in mind that a token is valid for 10 minutes. If you plan on making numerous API calls throughout the day, you'll have to generate a new token every 10 minutes.

How do I construct my URL for sending requests?

Use the following guidelines when sending requests using the Oracle InForm User Management Tool REST API.

URL Structure

Access the Oracle InForm User Management Tool REST resources using the following URL structure:

https://hs-umt-scim.oracleindustry.com/<resource-path>

Where <resource-path> is the relative path that defines the resource. For a complete list of resources and the paths for each, see All REST Endpoints.

Supported Methods

You can perform basic operations (create, update, and terminate) on Oracle InForm User Management Tool APIs using the standard HTTP method requests PUT, POST, and PATCH.

Media Types

The APIs currently support only the application/JSON media type.

Supported Headers

Oracle InForm User Management Tool REST APIs support only the Content-Type header to be passed in the header section of the HTTP request or response. The value for this header is specific to each API endpoint.

Compression

Use of compression on the Oracle InForm User Management Tool REST APIs resource request and response is not supported at this time.

What are the status codes for an API call?

When you call any of the Oracle InForm User Management Tool REST resources, the Response header returns one of the standard HTTP status codes defined in the following table:

HTTP Status Code	Description
`200 OK`	The request was completed successfully A 200 status is returned for a successful `PUT` or `PATCH` method.
`201 Created`	The request was fulfilled and resulted in a new resource being created.
`302 Server Not Accessible`	The server is not accessible. Redirected to https://www.oracleindustry.com/error/
`400 Bad Request`	The request could not be processed because it contains missing or invalid information (such as a validation error on a parameter or a missing required value).
`401 Unauthorized`	The request is not authorized. The authentication credentials included with this request are missing or invalid.
`403 Forbidden`	The user can't be authenticated. The user does not have authorization to perform this request.
`404 Not Found`	The request includes a resource URI that does not exist.
`405 Method Not Allowed`	The HTTP verb specified in the request (`PATCH`, `POST`, `PUT`) is not supported for this request URI.
`406 Not Acceptable`	The resource identified by this request is not capable of generating a representation corresponding to one of the media types in the Accept header of the request. For example, the request's Accept header is set to XML but the operation only returns JSON.
`415 Unsupported Media Type`	The client's Content-Type header is not correct (for example, the client attempts to send the request in XML, but the resource can only accept JSON).
`500 Internal Server Error`	The server encountered an unexpected condition that prevented it from fulfilling the request.
`503 Service Unavailable`	The server is unable to handle the request due to temporary overloading or maintenance of the server. The <ProductName> REST service is not currently running.