API

System APIs

POST system/data-sources

Creates a new data source

HTTP method POST
URI https://api.rambase.net/system/data-sources
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 2336, version 10

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
<DataSource>
2
     <Name
Name

Required/mandatory field

Name of the data source

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

The description of the datasource

This field is optional.

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

This will identify the type of the data source.

True = Old data source that will only be available for JHC
False = Will be available for "Output Designer" role and the new output designer

Default value: False

This field is optional.

>{Boolean}</IsDeprecated>
5
     <Cos
Cos

The cos number the datasource uses

This field is optional.

>
6
          <CosId
CosId

The cos number the datasource uses

This field is optional.

>{String}</CosId>
7
     </Cos>
8
</DataSource>
1
{
2
     "dataSource": {
3
          "name
Name

Required/mandatory field

Name of the data source

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

The description of the datasource

This field is optional.

": "{String}",
5
          "isDeprecated
IsDeprecated

This will identify the type of the data source.

True = Old data source that will only be available for JHC
False = Will be available for "Output Designer" role and the new output designer

Default value: False

This field is optional.

": "{Boolean}",
6
          "cos
Cos

The cos number the datasource uses

This field is optional.

": {
7
               "cosId
CosId

The cos number the datasource uses

This field is optional.

": "{String}"
8
          }
9
     }
10
}

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
<DataSource>
2
     <DataSourceId
DataSourceId

Data source identifier

>{Integer}</DataSourceId>
3
     <Status
Status

Data source status

>{Integer}</Status>
4
     <Name
Name

Name of the data source

>{String}</Name>
5
     <Description
Description

The description of the datasource

>{String}</Description>
6
     <Cos
Cos

The cos number the datasource uses

>
7
          <CosId
CosId

COS identifier

>{Integer}</CosId>
8
          <CosLink
CosLink

COS reference

>{String}</CosLink>
9
     </Cos>
10
     <IsDeprecated
IsDeprecated

This will identify the type of the data source.

True = Old data source that will only be available for JHC
False = Will be available for "Output Designer" role and the new output designer

>
11
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
12
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
13
               <UserId
UserId

User identifier

>{Integer}</UserId>
14
               <UserLink
UserLink

User reference

>{String}</UserLink>
15
          </ChangedBy>
16
          <OverriddenStatus
OverriddenStatus

Contains the global overridden object status if object status has been changed locally.

>{Integer}</OverriddenStatus>
17
          <Scope
Scope

Scope of the OPD (LOCAL/GLOBAL)

>{String}</Scope>
18
     </IsDeprecated>
19
</DataSource>
1
{
2
     "dataSource": {
3
          "dataSourceId
DataSourceId

Data source identifier

": "{Integer}",
4
          "status
Status

Data source status

": "{Integer}",
5
          "name
Name

Name of the data source

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

The description of the datasource

": "{String}",
7
          "cos
Cos

The cos number the datasource uses

": {
8
               "cosId
CosId

COS identifier

": "{Integer}",
9
               "cosLink
CosLink

COS reference

": "{String}"
10
          },
11
          "isDeprecated
IsDeprecated

This will identify the type of the data source.

True = Old data source that will only be available for JHC
False = Will be available for "Output Designer" role and the new output designer

": {
12
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
13
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
14
                    "userId
UserId

User identifier

": "{Integer}",
15
                    "userLink
UserLink

User reference

": "{String}"
16
               },
17
               "overriddenStatus
OverriddenStatus

Contains the global overridden object status if object status has been changed locally.

": "{Integer}",
18
               "scope
Scope

Scope of the OPD (LOCAL/GLOBAL)

": "{String}"
19
          }
20
     }
21
}

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:

Error 101079 HTTP 400 Mismatch in size of revision parameters