REST APIs for Oracle InForm User Management Tool

Get a list of sites

get

/scim/{trialname}/2.0/groups

Request

Supported Media Types

application/json
text/json
application/xml
text/xml
application/x-www-form-urlencoded

Path Parameters

trialname(required): string

Name of the InForm study.

Query Parameters

count: integer(int32)

page size

Default Value: ALL
filter: string

filter attributes supported: displayname, sitemnemonic. Operations supported: EQ, CO, SW, EW
startIndex: integer(int32)

start index (1-based)

Default Value: 1

Response

Supported Media Types

application/json
text/json
application/xml
text/xml

200 Response

Site details

Root Schema : SiteSearchResponse

Type: object

Show Source

itemsPerPage: integer(int64)
Resources: array Resources

site list
schemas: array schemas
startIndex: integer(int64)
totalResults: integer(int64)

{
    "type":"object",
    "properties":{
        "schemas":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
                ]
            }
        },
        "itemsPerPage":{
            "type":"integer",
            "format":"int64"
        },
        "startIndex":{
            "type":"integer",
            "format":"int64"
        },
        "totalResults":{
            "type":"integer",
            "format":"int64"
        },
        "Resources":{
            "type":"array",
            "description":"site list",
            "items":{
                "$ref":"#/definitions/Site"
            }
        }
    }
}

Nested Schema : Resources

Type: array

site list

Show Source

Array of: object Site

{
    "type":"array",
    "description":"site list",
    "items":{
        "$ref":"#/definitions/Site"
    }
}

Nested Schema : schemas

Type: array

Show Source

Array of: string

Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:ListResponse" ]

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "urn:ietf:params:scim:api:messages:2.0:ListResponse"
        ]
    }
}

Nested Schema : Site

Type: object

Show Source

displayName(required): string

Maximum Length: 255

Pattern: ([^~`!@#$%^&*()\+=\{\}\[\]\|\\"\<\>\?\/ ])+

A human-readable name for the site.
urn:umt:extension:schema:site(required): object UMTSite

{
    "type":"object",
    "required":[
        "displayName",
        "urn:umt:extension:schema:site"
    ],
    "properties":{
        "displayName":{
            "type":"string",
            "maxLength":"255",
            "pattern":" ([^~`!@#$%^&*()\\+=\\{\\}\\[\\]\\|\\\\\"\\<\\>\\?\\/\t])+",
            "description":"A human-readable name for the site."
        },
        "urn:umt:extension:schema:site":{
            "$ref":"#/definitions/UMTSite"
        }
    }
}

Nested Schema : UMTSite

Type: object

Show Source

active(required): boolean

Default value is true. Use PATCH with value true to re-instate. All other actions ignore this attribute.
addresses(required): addresses
DateFormat(required): DateFormat
email(required): string

Maximum Length: 255

Pattern: ^[A-Za-z0-9\._\#\!\$\&\'\*\/\=\?\^\`\{\}\~\|\%\+\-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}$

Email address for the site.
locale(required): locale
phoneNumbers(required): array phoneNumbers

Contact numbers for the site. Primary phone number is required. Pager type is not supported for site. The specific format for the contact number is user determined.
Reason(required): string

Maximum Length: 255

Reason for the change.
SignatureOrder(required): string

Allowed Values: [ "F,L", "L,F" ]

Study name signature order.
SiteMnemonic(required): string

Maximum Length: 20

Pattern: (\w|-|_| )+

Site Mnemonic. Also referred to as the site number.
timeZone(required): timeZone

{
    "type":"object",
    "required":[
        "SiteMnemonic",
        "email",
        "phoneNumbers",
        "addresses",
        "timeZone",
        "DateFormat",
        "locale",
        "active",
        "SignatureOrder",
        "Reason"
    ],
    "properties":{
        "SiteMnemonic":{
            "type":"string",
            "maxLength":"20",
            "pattern":"(\\w|-|_| )+",
            "description":"Site Mnemonic. Also referred to as the site number."
        },
        "email":{
            "type":"string",
            "maxLength":"255",
            "pattern":"^[A-Za-z0-9\\._\\#\\!\\$\\&\\'\\*\\/\\=\\?\\^\\`\\{\\}\\~\\|\\%\\+\\-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}$",
            "description":"Email address for the site."
        },
        "phoneNumbers":{
            "type":"array",
            "description":"Contact numbers for the site. Primary phone number is required. Pager type is not supported for site. The specific format for the contact number is user determined.",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ContactNumber"
                    }
                ]
            }
        },
        "addresses":{
            "allOf":[
                {
                    "$ref":"#/definitions/address"
                },
                {
                    "description":"Address for the site."
                }
            ]
        },
        "timeZone":{
            "allOf":[
                {
                    "$ref":"#/definitions/timeZone"
                },
                {
                    "description":"Timezone for the site. Please use one of the provided values."
                }
            ]
        },
        "DateFormat":{
            "allOf":[
                {
                    "$ref":"#/definitions/DateFormat"
                }
            ]
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/definitions/locale"
                },
                {
                    "description":"Site Study Locale."
                }
            ]
        },
        "active":{
            "type":"boolean",
            "description":"Default value is true. Use PATCH with value true to re-instate. All other actions ignore this attribute."
        },
        "SignatureOrder":{
            "type":"string",
            "description":"Study name signature order.",
            "enum":[
                "F,L",
                "L,F"
            ]
        },
        "Reason":{
            "type":"string",
            "maxLength":"255",
            "description":"Reason for the change."
        }
    }
}

Nested Schema : addresses

Match All

Show Source

object address
Address for the site.

{
    "allOf":[
        {
            "$ref":"#/definitions/address"
        },
        {
            "description":"Address for the site."
        }
    ]
}

Nested Schema : DateFormat

Match All

Show Source

string

Allowed Values: [ "Day / Month / Year", "Month / Day / Year", "Year / Month / Day" ]

DateFormat to be used.

{
    "allOf":[
        {
            "$ref":"#/definitions/DateFormat"
        }
    ]
}

Nested Schema : locale

Match All

Show Source

string

Allowed Values: [ "English (United States)", "Japanese (Japan)" ]
Site Study Locale.

{
    "allOf":[
        {
            "$ref":"#/definitions/locale"
        },
        {
            "description":"Site Study Locale."
        }
    ]
}

Nested Schema : phoneNumbers

Type: array

Contact numbers for the site. Primary phone number is required. Pager type is not supported for site. The specific format for the contact number is user determined.

Show Source

Array of: items

{
    "type":"array",
    "description":"Contact numbers for the site. Primary phone number is required. Pager type is not supported for site. The specific format for the contact number is user determined.",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ContactNumber"
            }
        ]
    }
}

Nested Schema : timeZone

Match All

Show Source

string

Allowed Values: [ "(UTC-07:00) Chihuahua, La Paz, Mazatlan", "(UTC-07:00) Mountain Time(US & Canada)", "(UTC-08:00) Baja California", "(UTC-08:00) Pacific Time(US & Canada)", "(UTC-09:00) Alaska", "(UTC-10:00) Hawaii", "(UTC-11:00) Coordinated Universal Time-11", "(UTC-12:00) International Date Line West", "(UTC+02:00) Chisinau", "(UTC-05:00) Bogota, Lima, Quito, Rio Branco", "(UTC-05:00) Eastern Time(US & Canada)", "(UTC-05:00) Indiana(East)", "(UTC-06:00) Central America", "(UTC-06:00) Central Time(US & Canada)", "(UTC-06:00) Guadalajara, Mexico City, Monterrey", "(UTC-06:00) Saskatchewan", "(UTC-07:00) Arizona", "(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi", "(UTC+02:00) Tripoli", "(UTC+03:00) Minsk", "(UTC+14:00) Kiritimati Island", "(UTC+11:00) Chokurdakh", "(UTC+12:00) Anadyr, Petropavlovsk-Kamchatsky", "(UTC+04:00) Izhevsk, Samara", "(UTC+01:00) Casablanca", "(UTC) Coordinated Universal Time", "(UTC+00:00) Dublin, Edinburgh, Lisbon, London", "(UTC+00:00) Monrovia, Reykjavik", "(UTC+01:00) Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna", "(UTC+01:00) Belgrade, Bratislava, Budapest, Ljubljana, Prague", "(UTC+01:00) Brussels, Copenhagen, Madrid, Paris", "(UTC+01:00) Sarajevo, Skopje, Warsaw, Zagreb", "(UTC+01:00) West Central Africa", "(UTC+02:00) Windhoek", "(UTC+02:00) Amman", "(UTC+02:00) Athens, Bucharest", "(UTC+02:00) Beirut", "(UTC+02:00) Cairo", "(UTC+02:00) Damascus", "(UTC+02:00) Harare, Pretoria", "(UTC+02:00) Helsinki, Kyiv, Riga, Sofia, Tallinn, Vilnius", "(UTC+03:00) Istanbul", "(UTC+02:00) Jerusalem", "(UTC+03:00) Baghdad", "(UTC+02:00) Kaliningrad", "(UTC+03:00) Kuwait, Riyadh", "(UTC+03:00) Nairobi", "(UTC+03:30) Tehran", "(UTC+04:00) Abu Dhabi, Muscat", "(UTC+04:00) Baku", "(UTC+03:00) Moscow, St. Petersburg", "(UTC+04:00) Port Louis", "(UTC+04:00) Tbilisi", "(UTC+04:00) Yerevan", "(UTC+04:30) Kabul", "(UTC+05:00) Islamabad, Karachi", "(UTC+05:00) Ashgabat, Tashkent", "(UTC+05:30) Sri Jayawardenepura", "(UTC+05:45) Kathmandu", "(UTC+06:00) Astana", "(UTC+06:00) Dhaka", "(UTC+05:00) Ekaterinburg", "(UTC+06:30) Yangon(Rangoon)", "(UTC+07:00) Bangkok, Hanoi, Jakarta", "(UTC+07:00) Novosibirsk", "(UTC+08:00) Beijing, Chongqing, Hong Kong, Urumqi", "(UTC+07:00) Krasnoyarsk", "(UTC+08:00) Kuala Lumpur, Singapore", "(UTC+08:00) Perth", "(UTC+08:00) Taipei", "(UTC+08:00) Ulaanbaatar", "(UTC+08:00) Irkutsk", "(UTC+09:00) Osaka, Sapporo, Tokyo", "(UTC+09:00) Seoul", "(UTC+09:30) Adelaide", "(UTC+09:30) Darwin", "(UTC+10:00) Brisbane", "(UTC+10:00) Canberra, Melbourne, Sydney", "(UTC+10:00) Guam, Port Moresby", "(UTC+10:00) Hobart", "(UTC+09:00) Yakutsk", "(UTC+11:00) Solomon Is., New Caledonia", "(UTC+10:00) Vladivostok", "(UTC+12:00) Auckland, Wellington", "(UTC+12:00) Coordinated Universal Time+12", "(UTC+12:00) Fiji", "(UTC+11:00) Magadan", "(UTC+12:00) Petropavlovsk - Kamchatsky - Old", "(UTC+13:00) Nuku'alofa", "(UTC+13:00) Samoa", "(UTC-01:00) Azores", "(UTC-01:00) Cabo Verde Is.", "(UTC-02:00) Coordinated Universal Time-02", "(UTC-03:00) Brasilia", "(UTC-03:00) City of Buenos Aires", "(UTC-03:00) Cayenne, Fortaleza", "(UTC-03:00) Greenland", "(UTC-03:00) Montevideo", "(UTC-03:00) Salvador", "(UTC-03:30) Newfoundland", "(UTC-04:00) Asuncion", "(UTC-04:00) Atlantic Time(Canada)", "(UTC-04:00) Cuiaba", "(UTC-04:00) Georgetown, La Paz, Manaus, San Juan", "(UTC-04:00) Santiago", "(UTC-04:00) Caracas", "(UTC-10:00) Aleutian Islands", "(UTC+07:00) Barnaul, Gorno-Altaysk", "(UTC+04:00) Astrakhan, Ulyanovsk", "(UTC+11:00) Bougainville Island", "(UTC+12:45) Chatham Islands", "(UTC-05:00) Havana", "(UTC-06:00) Easter Island", "(UTC-05:00) Chetumal", "(UTC-05:00) Haiti", "(UTC+10:30) Lord Howe Island", "(UTC-09:30) Marquesas Islands", "(UTC+11:00) Norfolk Island", "(UTC+09:00) Pyongyang", "(UTC+06:00) Omsk", "(UTC-03:00) Saint Pierre and Miquelon", "(UTC+11:00) Sakhalin", "(UTC-03:00) Araguaina", "(UTC+07:00) Tomsk", "(UTC+09:00) Chita", "(UTC-05:00) Turks and Caicos", "(UTC-08:00) Coordinated Universal Time-08", "(UTC-09:00) Coordinated Universal Time-09", "(UTC+07:00) Hovd", "(UTC+02:00) Gaza, Hebron", "(UTC+08:45) Eucla", "(UTC-03:00) Punta Arenas", "(UTC+04:00) Saratov", "(UTC+13:00) Coordinated Universal Time+13", "(UTC+04:00) Volgograd", "(UTC+00:00) Sao Tome", "(UTC+05:00) Qyzylorda" ]

Supported timezone values
Timezone for the site. Please use one of the provided values.

{
    "allOf":[
        {
            "$ref":"#/definitions/timeZone"
        },
        {
            "description":"Timezone for the site. Please use one of the provided values."
        }
    ]
}

Nested Schema : address

Type: object

Show Source

country(required): string

Maximum Length: 255

Pattern: ([a-zA-Z0-9]| | )+

The country name component.
formatted: string

Maximum Length: 255

Pattern: ([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+

Any additional line for the address after 'streetAddress'. This is labeled as 'Address2' in the Oracle User Management Tool application.
locality: string

Maximum Length: 255

Pattern: ([a-zA-Z0-9]| | )+

The city or locality component of the address.
postalCode: string

Maximum Length: 16

The zip code or postal code component.
region: string

Maximum Length: 255

Pattern: ([A-Z]|[a-z]| | )*

The state or region component.
streetAddress(required): string

Maximum Length: 255

Pattern: ([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+

The full street address component, which may include building number, street name, and P.O. box.

{
    "type":"object",
    "required":[
        "streetAddress",
        "country"
    ],
    "properties":{
        "streetAddress":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+",
            "description":"The full street address component, which may include building number, street name, and P.O. box."
        },
        "formatted":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+",
            "description":"Any additional line for the address after 'streetAddress'. This is labeled as 'Address2' in the Oracle User Management Tool application."
        },
        "locality":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([a-zA-Z0-9]| | )+",
            "description":"The city or locality component of the address."
        },
        "region":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([A-Z]|[a-z]| | )*",
            "description":"The state or region component."
        },
        "postalCode":{
            "type":"string",
            "maxLength":"16",
            "description":"The zip code or postal code component."
        },
        "country":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([a-zA-Z0-9]| | )+",
            "description":"The country name component."
        }
    }
}

Nested Schema : items

Match All

Show Source

object ContactNumber

{
    "allOf":[
        {
            "$ref":"#/definitions/ContactNumber"
        }
    ]
}

Nested Schema : ContactNumber

Type: object

Show Source

type(required): string

Allowed Values: [ "primary", "fax", "alternate", "pager" ]
value(required): string

Maximum Length: 25

Pattern: ([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+

{
    "type":"object",
    "required":[
        "type",
        "value"
    ],
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "primary",
                "fax",
                "alternate",
                "pager"
            ]
        },
        "value":{
            "type":"string",
            "maxLength":"25",
            "pattern":"([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+"
        }
    }
}

401 Response

Unauthorized. An invalid token or study name was provided

Root Schema : schema

Type: object

500 Response

Root Schema : schema

Type: object

Show Source

Message: string
Default Value: Error messages defined in the model.
- Unauthorized - An invalid token or study name was provided.
- Unknown error - Internal processing error. Please contact support.

{
    "type":"object",
    "properties":{
        "Message":{
            "type":"string",
            "description":"<ul>\n<li><i>Unauthorized</i> - An invalid token or study name was provided.</li> \n<li><i>Unknown error</i> -  Internal processing error. Please contact support.</li>\n</ul>\n",
            "default":"Error messages defined in the model."
        }
    }
}