API

RamBase REST APIs

POST system/api/api-operations/100385

See AOP

HTTP method POST
URI https://api.rambase.net/system/api/api-operations/100385
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 200
API resource identifier 2361, version 7

The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.

Format:
1
<Parameters>
2
     <ContentType
ContentType

Required/mandatory field

Contenttype of the application

Applicable domain values can be found here

>{String}</ContentType>
3
     <Description
Description

Required/mandatory field

Descriptive name of the application

>{String}</Description>
4
     <Namespace
Namespace

Namespace of the Application

This field is optional.

>{String}</Namespace>
5
     <LookupKey
LookupKey

Required/mandatory field

Matching Keyword

>{String}</LookupKey>
6
</Parameters>
1
{
2
     "parameters": {
3
          "contentType
ContentType

Required/mandatory field

Contenttype of the application

Applicable domain values can be found here

": "{String}",
4
          "description
Description

Required/mandatory field

Descriptive name of the application

": "{String}",
5
          "namespace
Namespace

Namespace of the Application

This field is optional.

": "{String}",
6
          "lookupKey
LookupKey

Required/mandatory field

Matching Keyword

": "{String}"
7
     }
8
}

The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.

$access_token String, optional After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time.
$db String, optional Set the database/company for the request
$useMinimumVersion Integer, optional Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information.
$lang String, optional Specifies the language used in the response, following the 3-letter ISO-639-1 [lll]

Read more about filters and sorting on how to use filter parameters and named filters.

Read more about filters and sorting on how to use sortable parameters

Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

List of available operations/actions for this resource.
See the operations documentation for more information about API operations.

Possible error codes the response might return: