Professional Documents
Culture Documents
Example Words or characters quoted from the screen. These include field names, screen titles,
pushbuttons labels, menu names, menu paths, and menu options.
Textual cross-references to other documents.
EXAMPLE Technical names of system objects. These include report names, program names,
transaction codes, table names, and key concepts of a programming language when they
are surrounded by body text, for example, SELECT and INCLUDE.
Example Output on the screen. This includes file and directory names and their paths, messages,
names of variables and parameters, source text, and names of installation, upgrade and
database tools.
Example Exact user entry. These are words or characters that you enter in the system exactly as they
appear in the documentation.
<Example> Variable user entry. Angle brackets indicate that you replace these words and characters
with appropriate entries to make entries in the system.
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
2 rights reserved. Typographic Conventions
Document History
1.6 2015-03-20 Added information about retrieving a list of license modules per a specified
customer
1.8 2016-03-02 Corrected error in Create Customer API sample and added Generate Security
Token API.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Document History rights reserved. 3
Table of Contents
1 Introduction.............................................................................................................................................. 7
1.1 Target Audience....................................................................................................................................................... 8
1.2 API Versioning.......................................................................................................................................................... 8
1.3 SLD Clients ............................................................................................................................................................... 8
1.4 Glossary .................................................................................................................................................................... 9
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
4 rights reserved. Table of Contents
5.3 Updating Customers ............................................................................................................................................ 54
5.4 Listing Customers................................................................................................................................................. 55
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Table of Contents rights reserved. 5
10.11 Listing License Files............................................................................................................................................. 126
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
6 rights reserved. Table of Contents
1 Introduction
The SAP Business One Cloud System Landscape Directory (SLD) service application programming interface (API)
is a collection of Representational State Transfer (REST) Web service APIs that enable partners and customers to
extend the functionality of SAP Business One Cloud to create industry specific functionality, develop missing
functionality, and interface with third-party tools.
The SLD service API uses Hypertext Transfer Protocol (HTTP) requests to specific Uniform Resource Locators
(URLs). You can pass URL parameters as arguments to Web services, which return data as Extensible Markup
Language (XML) or Javascript Object Notation (JSON) for consumption and processing by your application.
The SLD service API supports the following HTTP request methods:
GET – Requests a representation of a specified resource.
POST – Creates a new resource or updates an existing resource according to data contained in the body of the
request.
DELETE – Deletes a specified resource.
MERGE – Updates a representation of a specified resource. This method updates only the properties
mentioned in the request body, and leaves any unmentioned properties in their current state.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Introduction rights reserved. 7
1.1 Target Audience
This guide is aimed at customers and partners that are already familiar with REST Web service APIs and SAP
Business One Cloud.
For more information about SAP Business One Cloud, see SAP Business One Cloud Administrator’s Guide.
You can develop client applications that can communicate with the system landscape directory using the SAP
Business One Cloud SLD service API. To obtain a certificate token for using an SLD client in a cloud environment,
you must register the SLD client in the Cloud Control Center.
After obtaining a certificate token for your SLD client, ensure that you include the token in the HTTP headers sent
to the SLD with the name SBO-SLD-APP-ID.
Example
An example HTTP header including a certificate token is as follows:
SBO-SLD-APP-ID:
5645523035534C44423120636C69656E743A303134363236373630373039363736339D604FF7135B
3A8219F43ED23B2BD84788CD3A7F
Content-Length: 119
Connection: keep-alive
Accept: application/json
Content-Type: application/json
Procedure
To register an SLD client in the Cloud Control Center and obtain a certificate token, do the following:
1. In the Cloud Control Center, choose System Configuration SLD Clients, and then choose the Register
button.
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
8 rights reserved. Introduction
2. In the SLD Client Registration window, enter the name of your client application in the Name field.
3. Choose the Generate button.
The application generates a certificate token, which is displayed in the Identifier field.
4. Choose the Register button.
After the application successfully completes the registration process, choose the Close button.
5. To copy the certificate token, do the following:
1. In the Cloud Control Center, choose System Configuration SLD Clients, and then select the SLD client
for which you want to copy the token.
2. In the SLD Client Details area, highlight the value in the Identifier field, and then press C t r l + C .
1.4 Glossary
Term Description
Cloud Control Center An interface for the SLD service that Cloud Operators can use to manage an SAP
Business One Cloud landscape. You can register infrastructure components, add
users, and create service units and tenants.
Cloud Operator An authorized Cloud Control Center user responsible for managing an SAP Business
One Cloud landscape. Cloud Operators can belong only to a single customer, but can
be reassigned to other customers.
Common Database A central database containing system data, update packages, and add-ons. Multiple
tenants in the same service unit share a single common database.
Company Database A database that stores all business and transaction data. A single customer may
require several company databases.
Company Template A global folder that stores database backup files, which you can use to create tenants.
Repository
Customer A client organization that has purchased a subscription to remotely access SAP
Business One for a pre-defined period of time and specific number of named users,
according to contractual conditions.
Extension An additional component for SAP Business One, developed by SAP or a third-party, to
meet specific industry or niche business requirements.
Implementation A global folder that stores SAP Business One solution package (.PAK) files, which you
Repository can use to create tenants.
Power User Power users can access the following windows in SAP Business One that are not
available to regular users:
License windows
Add-on windows
Query windows
Presentation Server A server that provides tenants with remote access to the SAP Business One client
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Introduction rights reserved. 9
Term Description
application.
Presentation Server A collection of presentation servers that provide remote access to the SAP Business
Farm One client application for a single service unit.
Reseller A company that sells SAP software and provides first-level support to their customers.
Resellers market, sell, and implement customized SAP Business One Cloud solutions
and provide ongoing support, consulting, and education services to customers.
Reseller Operator An authorized Cloud Control Center user, employed by a reseller, responsible for
managing an SAP Business One landscape on behalf of their customers. Reseller
Operators can have multiple assigned customers.
SAP Business One A licensed SAP Business One user, who is a member of a customer that has purchased
User a subscription to remotely access SAP Business One Cloud. An SAP Business One
User can belong only to a single customer, and cannot be reassigned to other
customers.
Service Unit A collection of the software components, servers, and storage required to provide
access to a full SAP Business One installation. All SAP Business One components in a
single service unit have the same version. A single service unit can contain multiple
tenants with similar requirements.
Shared Folder A folder assigned to a service unit that contains sub-folders dedicated to individual
tenants, in which attachments, images, and document templates required to use SAP
Business One are stored.
SLD Agent Service An agent service that executes tasks on behalf of the SLD, such as performing
database upgrades.
SLD Client A client that can communicate with the system landscape directory using the SAP
Business One Cloud API.
Software Repository A shared folder accessible by all service units, containing SAP Business One
installation packages, upgrade packages, and add-on installers.
Superuser An SAP Business One User with additional permissions. In SAP Business One,
superusers can do the following:
Access all windows and perform all functions
Limit the authorizations of users that are not superusers
Caution
In a cloud environment, you can assign superuser permissions only to Cloud
Operators.
System Landscape A central directory of all SAP Business One components in a cloud landscape. A
Directory (SLD) service provides information about software components and their settings, how
resources are grouped into service units, and registered customers, tenants, and
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
10 rights reserved. Introduction
Term Description
users.
User Access Portal A web site where users can enter their logon credentials to remotely access the SAP
Business One application.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Introduction rights reserved. 11
2 Authentication API
You can use the Authentication API to log on to and log off from the system landscape directory.
2.1 Logging On
Property Description
Parameters None
Response Body If the logon is successful, the value is true. Otherwise, the value is false.
Syntax
POST {"Account":"username","Password":"password"}
{
"d" : {
"LogonBySystemUser" : true
}
}
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
12 rights reserved. Authentication API
2.2 Logging Off
Property Description
Parameters None
Syntax
GET https://hostname:port/sld/sld<version>.svc/Logoff
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Authentication API rights reserved. 13
3 Generate Security Token
You can use this API to generate a security token. With this security token, you can operate methods to get, add
or update information in SLD. These methods are creating, deleting, updating customers or tenants, binding and
unbinding users to/from tenants, adding and removing users to/from customers.
Property Description
Parameters None
Syntax
GET https://hostname:port/sld/sld<version>.svc/GenerateSecurityToken
{
"d" : {
"GenerateSecurityToken" : "
5645523035534C4453595354454D5F4C414E4453434150455F4445524943544F52593A2D30383034393237
3231393938373834C4F9ED4F342D2104C7A7DF67F0331A1E285E40AA"
}
}
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
14 rights reserved. Generate Security Token
4 Monitoring API
You can use the Monitoring API to check the status and availability of landscape components in cloud
environments.
Property Description
Parameters None
Syntax
GET https://hostname:port/sld/sld<version>.svc/SLDStatusCheck
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 15
"d":{
"SLDStatusCheck":{
"__metadata":{
"type":"SLDModel.SLDStatus"
},
"Code": 0,
"Status": "Available",
"Message": "SLD service status is available."
}
}
}
Checks the status of SLD agents in a cloud landscape, according to the hostname in the request URL.
Property Description
Parameters Hostname – The hostname of the SLD agent that you want to check. This
parameter is optional. If you do not specify this parameter, the service
checks the status of all SLD agents in a cloud landscape.
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
16 rights reserved. Monitoring API
Property Description
reachable.
UpdateTime – The timestamp of the last status update for the SLD
agent.
Messages – An explanation of the status and detailed warning
information.
Syntax
GET https://hostname:port/sld/sld<version>.svc/CheckSLDAgentStatus?Hostname='XX'
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 3,
"Name" : "XX",
"ComponentType" : "SLD Agent",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358751964840)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12500,
"Level" : 0,
"Status" : "Available",
"Content" : "SLD agent service on \"XX\" is available"
}]
}
}]
}
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 17
4.3 Monitoring License Servers
You can check the status of license servers using hostnames or the identification numbers automatically
generated by the SLD upon registration.
Checks the status of license servers in a cloud landscape, according to the hostname in the request URL.
Property Description
Parameters Hostname – The hostname of the license server that you want to check. This
parameter is optional. If you do not specify this parameter, the service
checks the status of all license servers in a cloud landscape.
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
18 rights reserved. Monitoring API
Property Description
information.
Error Codes 500, 502, 1047, 12010, 12011, 12012, 12013, 12014, 12015
Syntax
GET https://hostname:port/sld/sld<version>.svc/CheckLicenseServerStatus?Hostname='XX'
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 2,
"Name" : "XX",
"ComponentType" : "License Server",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358241673621)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12010,
"Level" : 0,
"Status" : "Available",
"Content" : "License server is available"
}]
}
}]
}
}
Checks the status of license servers in a cloud landscape, according to the identification number in the request
URL.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 19
Property Description
Parameters ID – The identification number of the license server that you want to check.
This parameter is optional. If you do not specify this parameter, the service
checks the status of all license servers in a cloud landscape.
Error Codes 500, 502, 1047, 12010, 12011, 12012, 12013, 12014, 12015
Syntax
GET https://hostname:port/sld/sld<version>.svc/CheckLicenseServerStatusByID?ID='2'
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
20 rights reserved. Monitoring API
Sample Response Body
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 2,
"Name" : "XX",
"ComponentType" : "License Server",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358241673621)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12010,
"Level" : 0,
"Status" : "Available",
"Content" : "License server is available"
}]
}
}]
}
}
You can check the status of database instances using names or the identification numbers automatically
generated by the SLD upon registration.
Checks the status of database instances in a cloud landscape, according to the name in the request URL.
Property Description
Parameters DatabaseInstanceName – The name of the database instance that you want
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 21
Property Description
to check. This parameter is optional. If you do not specify this parameter,
the service checks the status of all database instances in a cloud landscape.
Syntax
GET https://hostname:port/sld/sld<version>.svc/CheckDatabaseInstanceStatus?
DatabaseInstanceName='XX'
{
"d" : {
"results" : [{
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
22 rights reserved. Monitoring API
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 2,
"Name" : "XX",
"ComponentType" : "DatabaseInstance",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358749925770)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12020,
"Level" : 0,
"Status" : "Available",
"Content" : "Database instance is available"
}]
}
}]
}
}
Checks the status of database instances in a cloud landscape, according to the identification number in the
request URL.
Property Description
Parameters ID – The identification number of the database instance that you want to
check. This parameter is optional. If you do not specify this parameter, the
service checks the status of all database instances in a cloud landscape.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 23
Property Description
instance. The possible values are:
o 0 – The database instance is available.
o 10 – The database instance is offline.
o 30 – The SLD cannot connect to the database instance.
o 40 – The machine running the database instance is not reachable.
Status – The status of the database instance. The possible values are:
o Available – The database instance is available.
o Warning – The database instance is offline.
o Service Not Reachable – The SLD cannot connect to the database
instance.
o Machine Not Reachable – The machine running the database
instance is not reachable.
UpdateTime – The timestamp of the last status update for the database
instance.
Messages – An explanation of the status and detailed warning
information.
Syntax
GET https://hostname:port/sld/sld<version>.svc/CheckDatabaseInstanceStatusByID?ID='2'
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 2,
"Name" : "XX",
"ComponentType" : "DatabaseInstance",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358749925770)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12020,
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
24 rights reserved. Monitoring API
"Level" : 0,
"Status" : "Available",
"Content" : "Database instance is available"
}]
}
}]
}
}
You can check the status of common databases using names or the identification numbers automatically
generated by the SLD upon registration.
Checks the status of common databases in a cloud landscape, according to the name in the request URL.
Property Description
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 25
Property Description
o 10 – The common database is offline.
o 20 – The SLD cannot retrieve the common database version.
o 30 – The SLD cannot connect to the database instance holding the
common database, the common database does not exist on the
specified database instance, or the SLD encountered an error while
connecting to the common database.
o 40 – The machine running the common database is not reachable.
Status – The status of the common database. The possible values are:
o Available – The common database is available.
o Warning – The common database is offline.
o Service Error – The SLD cannot retrieve the common database
version.
o Service Not Reachable – The SLD cannot connect to the database
instance holding the common database, the common database
does not exist on the specified database instance, or the SLD
encountered an error while connecting to the common database.
o Machine Not Reachable – The machine running the common
database is not reachable.
UpdateTime – The timestamp of the last status update for the common
database.
Messages – An explanation of the status and detailed warning
information.
Error Codes 500, 502, 801, 806, 3003, 12020, 12021, 12022, 12023, 12200, 12201,
12202, 12203, 12204
Syntax
GET
https://hostname:port/sld/sld<version>.svc/CheckCommonDatabaseStatus?DatabaseInstanceN
ame='XX'&CommonDatabaseName='SBO-COMMON'
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 5,
"Name" : "SBO-COMMON",
"ComponentType" : "CommonDatabase",
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
26 rights reserved. Monitoring API
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358750526487)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12200,
"Level" : 0,
"Status" : "Available",
"Content" : "Common database is available"
}]
}
}]
}
}
Checks the status of common databases in a cloud landscape, according to the identification number in the
request URL.
Property Description
Parameters ID – The identification number of the database instance that you want to
check. This parameter is optional. If you do not specify this parameter, te
service checks the status of all database instances in a cloud landscape.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 27
Property Description
o 30 – The SLD cannot connect to the database instance holding the
common database, the common database does not exist on the
specified database instance, or the SLD encountered an error while
connecting to the common database.
o 40 – The machine running the common database is not reachable.
Status – The status of the common database. The possible values are:
o Available – The common database is available.
o Warning – The common database is offline.
o Service Error – The SLD cannot retrieve the common database
version.
o Service Not Reachable – The SLD cannot connect to the database
instance holding the common database, the common database
does not exist on the specified database instance, or the SLD
encountered an error while connecting to the common database.
o Machine Not Reachable – The machine running the common
database is not reachable.
UpdateTime – The timestamp of the last status update for the common
database.
Messages – An explanation of the status and detailed warning
information.
Error Codes 500, 502, 801, 806, 3003, 12020, 12021, 12022, 12023, 12200, 12201,
12202, 12203, 12204
Syntax
GET https://hostname:port/sld/sld<version>.svc/CheckCommonDatabaseStatusByID?ID='2'
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 5,
"Name" : "SBO-COMMON",
"ComponentType" : "CommonDatabase",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358750526487)\/",
"Messages" : {
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
28 rights reserved. Monitoring API
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12200,
"Level" : 0,
"Status" : "Available",
"Content" : "Common database is available"
}]
}
}]
}
}
You can check the status of mailer services using hostnames or the identification numbers automatically
generated by the SLD upon registration.
Checks the status of mailer services in a cloud landscape, according to the hostname in the request URL.
Property Description
Parameters Hostname – The hostname of the mailer service that you want to check.
This parameter is optional. If you do not specify this parameter, the service
checks the status of all mailer services in a cloud landscape.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 29
Property Description
or the logon credentials for the SMTP server are incorrect.
o 20 – The SLD cannot connect to the SMTP server or an error
occurred during the SMTP server logon authentication.
o 30 – The mailer service is not reachable using the notification
channel.
o 40 – The machine running the mailer service is not reachable.
Status – The status of the mailer service. The possible values are:
o Available – The mailer service is available.
o Warning – The mailer service is offline, the SMTP server is not
configured, or the logon credentials for the SMTP server are
incorrect.
o Service Error – The SLD cannot connect to the SMTP server or an
error occurred during the SMTP server logon authentication.
o Service Not Reachable – The mailer service is not reachable using
the notification channel.
o Machine Not Reachable – The machine running the mailer service is
not reachable.
UpdateTime – The timestamp of the last status update for the mailer
service.
Messages – An explanation of the status and detailed warning
information.
Error Codes 500, 502, 12040, 12041, 12042, 12043, 12044, 12045, 12046, 12047
Syntax
GET https://hostname:port/sld/sld<version>.svc/CheckMailerServiceStatus?Hostname='XX'
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 1,
"Name" : "XX",
"ComponentType" : "Mailer",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358753376093)\/",
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
30 rights reserved. Monitoring API
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12040,
"Level" : 0,
"Status" : "Available",
"Content" : "Mailer service is available"
}]
}
}]
}
}
Checks the status of mailer services in a cloud landscape, according to the identification number in the request
URL.
Property Description
Parameters ID – The identification number of the mailer service that you want to check.
This parameter is optional. If you do not specify this parameter, the service
checks the status of all mailer services in a cloud landscape.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 31
Property Description
o 40 – The machine running the mailer service is not reachable.
Status – The status of the mailer service. The possible values are:
o Available – The mailer service is available.
o Warning – The mailer service is offline, the SMTP server is not
configured, or the logon credentials for the SMTP server are
incorrect.
o Service Error – The SLD cannot connect to the SMTP server or an
error occurred during the SMTP server logon authentication.
o Service Not Reachable – The mailer service is not reachable using
the notification channel.
o Machine Not Reachable – The machine running the mailer service is
not reachable.
UpdateTime – The timestamp of the last status update for the mailer
service.
Messages – An explanation of the status and detailed warning
information.
Error Codes 500, 502, 12040, 12041, 12042, 12043, 12044, 12045, 12046, 12047
Syntax
GET https://hostname:port/sld/sld<version>.svc/CheckMailerServiceStatusByID?ID='1'
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 1,
"Name" : "XX",
"ComponentType" : "Mailer",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358753376093)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12040,
"Level" : 0,
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
32 rights reserved. Monitoring API
"Status" : "Available",
"Content" : "Mailer service is available"
}]
}
}]
}
}
You can check the status of integration components using hostnames or the identification numbers automatically
generated by the SLD upon registration.
Checks the status of integration components in a cloud landscape, according to the hostname in the request URL.
Property Description
Parameters Hostname – The hostname of the integration component that you want to
check. This parameter is optional. If you do not specify this parameter, the
service checks the status of all integration components in a cloud
landscape.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 33
Property Description
o 40 – The machine running the integration component is not
reachable.
o 5 – The service cannot determine the status of the integration
component because there is a problem with the configuration.
Status – The status of the integration component. The possible values
are:
o Available – The integration component is available.
o Warning – The integration component is offline or the required
version information is not registered.
o Service Error – The integration component is not available.
o Service Not Reachable – The integration component is not
reachable.
o Machine Not Reachable – The machine running the integration
component is not reachable.
o Unknown – The service cannot determine the status of the
integration component because there is a problem with the
configuration.
UpdateTime – The timestamp of the last status update for the
integration component.
Messages – An explanation of the status and detailed warning
information.
Error Codes 500, 502, 12030, 12031, 12032, 12033, 12034, 12035
Syntax
GET
https://hostname:port/sld/sld<version>.svc/CheckIntegrationComponentStatus?Hostname='X
X'
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 2,
"Name" : "XX",
"ComponentType" : "IntegrationComponent",
"StatusCode" : 0,
"Status" : "Available",
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
34 rights reserved. Monitoring API
"UpdateTime" : "\/Date(1358754638517)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12030,
"Level" : 0,
"Status" : "Available",
"Content" : "Integration component is available"
}]
}
}]
}
}
Checks the status of integration components in a cloud landscape, according to the identification number in the
request URL.
Property Description
Parameters ID – The identification number of the integration component that you want
to check. This parameter is optional. If you do not specify this parameter,
the service checks the status of all integration components in a cloud
landscape.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 35
Property Description
o 40 – The machine running the integration component is not
reachable.
o 5 – The service cannot determine the status of the integration
component because there is a problem with the configuration.
Status – The status of the integration component. The possible values
are:
o Available – The integration component is available.
o Warning – The integration component is offline or the required
version information is not registered.
o Service Error – The integration component is not available.
o Service Not Reachable – The integration component is not
reachable.
o Machine Not Reachable – The machine running the integration
component is not reachable.
o Unknown – The service cannot determine the status of the
integration component because there is a problem with the
configuration.
UpdateTime – The timestamp of the last status update for the
integration component.
Messages – An explanation of the status and detailed warning
information.
Error Codes 500, 502, 12030, 12031, 12032, 12033, 12034, 12035
Syntax
GET
https://hostname:port/sld/sld<version>.svc/CheckIntegrationComponentStatusByID?ID='2'
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 2,
"Name" : "XX",
"ComponentType" : "IntegrationComponent",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358754638517)\/",
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
36 rights reserved. Monitoring API
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12030,
"Level" : 0,
"Status" : "Available",
"Content" : "Integration component is available"
}]
}
}]
}
}
You can check the status of different storage types using paths or the identification numbers automatically
generated by the SLD upon registration.
Checks the status of different storage types in a cloud landscape, according to the path in the request URL.
Property Description
Parameters StorageType – The type of storage that you want to check. This
parameter is mandatory. The possible values are:
o SharedFolder – A folder assigned to a service unit that contains
sub-folders dedicated to individual tenants, in which attachments,
images, and document templates required to use SAP Business
One are stored.
o UsersStorage – A global folder that contains sub-folders dedicated
to individual users, in which user-sensitive data and documents are
stored.
o SoftwareRepository – A shared folder accessible by all service units,
containing SAP Business One installation packages, upgrade
packages, and add-on installers.
o CompanyTemplateRepository – One or more folders shared by the
entire cloud landscape folder that store database backup files,
which you can use to create company databases.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 37
Property Description
o TenantsStorage – A folder assigned to a service unit that contains
sub-folders dedicated to individual tenants, in which logs and
company database backup files, used during tenant upgrades, are
stored.
o ImplementationRepository – One or more folders shared by the
entire cloud landscape that store SAP Business One solution
package (.PAK) files, which you can use to create company
databases.
StoragePath – The path to the storage that you want to check. This
parameter is mandatory.
Syntax
GET
https://hostname:port/sld/sld<version>.svc/CheckStorageStatus?StorageType='XX'&Storage
Path='YY'
{
"d" : {
"results" : [{
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
38 rights reserved. Monitoring API
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 2,
"ComponentType" : "SharedFolder",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358756818563)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12401,
"Level" : 0,
"Status" : "Available",
"Content" : "Shared folder is available"
}]
}
}]
}
}
Checks the status of different storage types in a cloud landscape, according to the identification number in the
request URL.
Property Description
Parameters StorageType – The type of storage that you want to check. This
parameter is mandatory. The possible values are:
o SharedFolder – A folder assigned to a service unit that contains
sub-folders dedicated to individual tenants, in which attachments,
images, and document templates required to use SAP Business
One are stored.
o UsersStorage – A global folder that contains sub-folders dedicated
to individual users, in which user-sensitive data and documents are
stored.
o SoftwareRepository – A shared folder accessible by all service units,
containing SAP Business One installation packages, upgrade
packages, and add-on installers.
o CompanyTemplateRepository – One or more folders shared by the
entire cloud landscape folder that store database backup files,
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 39
Property Description
which you can use to create company databases.
o TenantsStorage – A folder assigned to a service unit that contains
sub-folders dedicated to individual tenants, in which logs and
company database backup files, used during tenant upgrades, are
stored.
o ImplementationRepository – One or more folders shared by the
entire cloud landscape that store SAP Business One solution
package (.PAK) files, which you can use to create company
databases.
ID – The identification number of the storage that you want to check.
This parameter is optional. If you do not specify this parameter, the
system checks the status of storage with the specified type in a cloud
landscape.
Syntax
GET
https://hostname:port/sld/sld<version>.svc/CheckStorageStatusByID?StorageType='XX'&ID=
'2'
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
40 rights reserved. Monitoring API
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 2,
"ComponentType" : "SharedFolder",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358756818563)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12401,
"Level" : 0,
"Status" : "Available",
"Content" : "Shared folder is available"
}]
}
}]
}
}
You can check the status of presentation servers using hostnames or the identification numbers automatically
generated by the SLD upon registration.
Checks the status of presentation servers in a cloud landscape, according to the hostname in the request URL.
Property Description
Parameters Hostname – The hostname of the presentation server that you want to
check. This parameter is optional. If you do not specify this parameter, the
service checks the status of all presentation servers in a cloud landscape.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 41
Property Description
Error Codes 500, 502, 12300, 12301, 12302, 12303, 12304, 12305, 12501
Syntax
GET
https://hostname:port/sld/sld<version>.svc/CheckPresentationServerStatus?Hostname='XX'
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
42 rights reserved. Monitoring API
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 1,
"Name" : "XX",
"ComponentType" : "PresentationServer",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358758392937)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12300,
"Level" : 0,
"Status" : "Available",
"Content" : "Presentation server is available"
}]
}
}]
}
}
Checks the status of presentation servers in a cloud landscape, according to the identification number in the
request URL.
Property Description
Parameters ID – The identification number of the presentation server that you want to
check. This parameter is optional. If you do not specify this parameter, the
service checks the status of all presentation servers in a cloud landscape.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 43
Property Description
ComponentType – The type of component.
StatusCode – An integer code indicating the status of the presentation
server. The possible values are:
o 0 – The presentation server is available.
o 10 – The presentation server is offline or under maintenance.
o 20 – The SLD cannot connect to the RDS or Citrix services.
o 30 – The SLD Agent of the presentation server is not reachable.
o 40 – The machine running the presentation server is not reachable.
o 5 – The service cannot determine the status of the presentation
server because there is a problem with the configuration.
Status – The status of the presentation server. The possible values are:
o Available – The presentation server is available.
o Warning – The presentation server is offline or under maintenance.
o Service Error – The SLD cannot connect to the RDS or Citrix
services.
o Service Not Reachable – The SLD Agent of the presentation server
is not reachable.
o Machine Not Reachable – The machine running the presentation
server is not reachable.
o Unknown – The service cannot determine the status of the
presentation server because there is a problem with the
configuration.
UpdateTime – The timestamp of the last status update for the
presentation server.
Messages – An explanation of the status and detailed warning
information.
Error Codes 500, 502, 12300, 12301, 12302, 12303, 12304, 12305, 12501
Syntax
GET
https://hostname:port/sld/sld<version>.svc/CheckPresentationServerStatusByID?ID='1'
{
"d" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringStatusParam"},
"ID" : 1,
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
44 rights reserved. Monitoring API
"Name" : "XX",
"ComponentType" : "PresentationServer",
"StatusCode" : 0,
"Status" : "Available",
"UpdateTime" : "\/Date(1358758392937)\/",
"Messages" : {
"results" : [{
"__metadata" : {"type" : "SLDModel.MonitoringMessage"},
"Code" : 12300,
"Level" : 0,
"Status" : "Available",
"Content" : "Presentation server is available"
}]
}
}]
}
}
You can check the status of service units using names or the identification numbers automatically generated by
the SLD upon registration.
Checks the status of service units in a cloud landscape, according to the name in the request URL.
Property Description
Parameters Name – The name of the service unit that you want to check. This parameter
is optional. If you do not specify this parameter, the service checks the
status of all service units in a cloud landscape.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 45
Property Description
Name – The name of the service unit.
ComponentType – The type of component.
StatusCode – An integer code indicating the status of the service unit.
The possible values are:
o 0 – All components of the service unit are available.
o 10 – The service unit is offline or one or more components of the
service unit have warnings.
o 20 – One or more of the components of the service unit report
errors.
o 30 – One or more of the components of the service unit are not
reachable.
o 40 – One or more of the machines running components of the
service unit are not reachable.
Status – The status of the service unit. The possible values are:
o Available – All components of the service unit are available.
o Warning – The service unit is offline or one or more components of
the service unit have warnings.
o Service Error – One or more of the components of the service unit
report errors.
o Service Not Reachable – One or more of the components of the
service unit are not reachable.
o Machine Not Reachable – One or more of the machines running
components of the service unit are not reachable.
UpdateTime – The timestamp of the last status update for the service
unit.
Messages – An explanation of the status and detailed warning
information.
Error Codes 500, 502, 801, 806, 1047, 3003, 12010, 12011, 12012, 12013, 12014, 12015,
12020, 12021, 12022, 12023, 12030, 12031, 12032, 12033, 12034, 12035,
12040, 12041, 12042, 12043, 12044, 12045, 12046, 12047, 12200, 12201,
12202, 12203, 12204, 12300, 12301, 12302, 12303, 12304, 12305, 12400,
12401, 12402, 12500, 12501, 12502, 12600, 12601
Syntax
GET https://hostname:port/sld/sld<version>.svc/CheckServiceUnitStatusByName?Name='XX'
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
46 rights reserved. Monitoring API
"d" : {
"results" : [
{
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringStatusParam"
}, "ID" : 3, "Name" : "XX", "ComponentType" : "ServiceUnit", "StatusCode" : 0,
"Status" : "Available", "UpdateTime" : "\/Date(1358760701940)\/", "Messages" : {
"results" : [
{
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 2, "ComponentName" : "cnpvgvb1od014", "ComponentType" :
"LicenseServer", "Code" : 12010, "Level" : 0, "Status" : "Available", "Content" :
"License server is available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 6, "ComponentName" : "SBO-COMMON", "ComponentType" :
"CommonDatabase", "Code" : 12200, "Level" : 0, "Status" : "Available", "Content" :
"Common database is available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 4, "ComponentName" : "CNPVGVB1OD057", "ComponentType" :
"DatabaseInstance", "Code" : 12020, "Level" : 0, "Status" : "Available", "Content" :
"Database instance is available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 6, "ComponentType" : "CompanyTemplateRepository", "Code" : 12401,
"Level" : 0, "Status" : "Available", "Content" : "Company template repository is
available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 6, "ComponentType" : "ImplementationRepository", "Code" : 12401,
"Level" : 0, "Status" : "Available", "Content" : "Implementation repository is
available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 4, "ComponentType" : "SoftwareRepository", "Code" : 12401, "Level"
: 0, "Status" : "Available", "Content" : "Software repository is available"
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 47
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 4, "ComponentType" : "SharedFolder", "Code" : 12401, "Level" : 0,
"Status" : "Available", "Content" : "Shared folder is available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 4, "ComponentType" : "TenantsStorage", "Code" : 12401, "Level" : 0,
"Status" : "Available", "Content" : "Tenant storage is available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 10, "ComponentName" : "cnpvgvb1od057", "ComponentType" :
"PresentationServer", "Code" : 12300, "Level" : 0, "Status" : "Available", "Content" :
"Presentation server is available"
}
]
}
}
]
}
}
Checks the status of service units in a cloud landscape, according to the identification number in the request URL.
Property Description
Parameters ID – The identification number of the service unit that you want to check.
This parameter is optional. If you do not specify this parameter, the service
checks the status of all service units in a cloud landscape.
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
48 rights reserved. Monitoring API
Property Description
ComponentType – The type of component.
StatusCode – An integer code indicating the status of the service unit.
The possible values are:
o 0 – All components of the service unit are available.
o 10 – The service unit is offline or one or more components of the
service unit have warnings.
o 20 – One or more of the components of the service unit report
errors.
o 30 – One or more of the components of the service unit are not
reachable.
o 40 – One or more of the machines running components of the
service unit are not reachable.
Status – The status of the service unit. The possible values are:
o Available – All components of the service unit are available.
o Warning – The service unit is offline or one or more components of
the service unit have warnings.
o Service Error – One or more of the components of the service unit
report errors.
o Service Not Reachable – One or more of the components of the
service unit are not reachable.
o Machine Not Reachable – One or more of the machines running
components of the service unit are not reachable.
UpdateTime – The timestamp of the last status update for the service
unit.
Messages – An explanation of the status and detailed warning
information.
Error Codes 500, 502, 801, 806, 1047, 3003, 12010, 12011, 12012, 12013, 12014, 12015,
12020, 12021, 12022, 12023, 12030, 12031, 12032, 12033, 12034, 12035,
12040, 12041, 12042, 12043, 12044, 12045, 12046, 12047, 12200, 12201,
12202, 12203, 12204, 12300, 12301, 12302, 12303, 12304, 12305, 12400,
12401, 12402, 12500, 12501, 12502, 12600, 12601
Syntax
GET https://hostname:port/sld/sld<version>.svc/CheckServiceUnitStatusByID?ID='3'
{
"d" : {
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 49
"results" : [
{
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringStatusParam"
}, "ID" : 3, "Name" : "XX", "ComponentType" : "ServiceUnit", "StatusCode" : 0,
"Status" : "Available", "UpdateTime" : "\/Date(1358760701940)\/", "Messages" : {
"results" : [
{
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 2, "ComponentName" : "cnpvgvb1od014", "ComponentType" :
"LicenseServer", "Code" : 12010, "Level" : 0, "Status" : "Available", "Content" :
"License server is available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 6, "ComponentName" : "SBO-COMMON", "ComponentType" :
"CommonDatabase", "Code" : 12200, "Level" : 0, "Status" : "Available", "Content" :
"Common database is available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 4, "ComponentName" : "CNPVGVB1OD057", "ComponentType" :
"DatabaseInstance", "Code" : 12020, "Level" : 0, "Status" : "Available", "Content" :
"Database instance is available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 6, "ComponentType" : "CompanyTemplateRepository", "Code" : 12401,
"Level" : 0, "Status" : "Available", "Content" : "Company template repository is
available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 6, "ComponentType" : "ImplementationRepository", "Code" : 12401,
"Level" : 0, "Status" : "Available", "Content" : "Implementation repository is
available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 4, "ComponentType" : "SoftwareRepository", "Code" : 12401, "Level"
: 0, "Status" : "Available", "Content" : "Software repository is available"
}, {
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
50 rights reserved. Monitoring API
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 4, "ComponentType" : "SharedFolder", "Code" : 12401, "Level" : 0,
"Status" : "Available", "Content" : "Shared folder is available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 4, "ComponentType" : "TenantsStorage", "Code" : 12401, "Level" : 0,
"Status" : "Available", "Content" : "Tenant storage is available"
}, {
"__metadata" : {
"type" : "SLDModel.ComponentMonitoringMessage"
}, "ComponentID" : 10, "ComponentName" : "cnpvgvb1od057", "ComponentType" :
"PresentationServer", "Code" : 12300, "Level" : 0, "Status" : "Available", "Content" :
"Presentation server is available"
}
]
}
}
]
}
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Monitoring API rights reserved. 51
5 Customer API
You can use the Customer API to query customer information, create new customers, and update and delete
customers.
Creates a new customer in the SLD with the information contained in the request body.
Note
Depending on the type of operator creating the customer, the SLD performs the following actions:
o Reseller Operator – Automatically assigns the new customer to the reseller to which the reseller
operator belongs.
o Cloud Operator – Does not automatically assign the new customer to any resellers. The Cloud
Operator must use the Reseller API to manually assign the customer to a reseller. For more
information, see Reseller API.
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
52 rights reserved. Customer API
Property Description
Error Codes 501, 1001, 1002, 3000, 3018, 3115, 3116, 3118, 3121, 3123, 3124, 3125, 3126,
3127, 3128, 3131, 3132, 3134, 3135, 3138, 3139, 4105, 4201, 8202
Syntax
Deletes a specified customer from the SLD, according to the identification number in the request URL. To delete a
customer, you must ensure that the specified customer does not have any tenants.
Property Description
Parameters None
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Customer API rights reserved. 53
Property Description
Syntax
DELETE https://hostname:port/sld/sld<version>.svc/Customers(id)
Updates the information contained in the request body for a specified customer, according to the identification
number in the request URL.
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
54 rights reserved. Customer API
Property Description
Syntax
MERGE { ID : id,
Name : “ OEM Computers “,
Type : “Customer”,
ContactPerson : “ Adams “,
Phone : “021-60001000”,
Email: “ Marcus. Adams @oem.com “,
Location : “Shanghai”,
Country : “China”,
Industry : “IT”,
EmployeeCount : 100,
Status : “Online”,
Description : “Create an Customer”,
InstallationNumber : “Your InstallationNumber”,
}
Property Description
Parameters None
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Customer API rights reserved. 55
Property Description
Business One Cloud. By default, the value is Customer.
ContactPerson – The name of the customer’s contact person.
Phone – The phone number of the customer’s contact person.
Email – The email address of the customer’s contact person.
Location – The address of the customer.
Country – The country in which the customer is located.
Industry – The industry in which the customer operates.
EmployeeCount – The number of people that the customer employs.
Status – The status of the customer. The possible values are:
o Online – Users of the customer can log on to SAP Business One.
o Offline – Users of the customer cannot log on to SAP Business One.
Description – A description for this customer.
InstallationNumber – The installation number of the license file assigned
to the customer. This attribute is mandatory.
Reseller – The reseller to which the customer is assigned.
Syntax
GET https://hostname:port/sld/sld<version>.svc/Customers
{
“d”: {
“results”: [
{
“ContactPerson”: “ Adams “,
“Country”: “China”,
“Description”: “Create an Customer”,
“Email”: “ Marcus. Adams @oem.com “,
“EmployeeCount”: 100,
“Group”: {
“__deferred”: {
“uri”: “http://hostname:port/sld/sld<version>.svc/Customers(25)/Group”
}
},"Reseller": {
"__deferred": {
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
56 rights reserved. Customer API
"uri": "http://127.0.0.1:8080/sld/sld0100.svc/Customers(25)/Reseller"
}
},
“ID”: 25,
“Industry”: “IT”,
“InstallationNumber”: “Your InstallationNumber”,
“Location”: “Shanghai”,
“Name”: “ OEM Computers “,
“Phone”: “021-60001000”,
“Status”: “Online”,
“Type”: “Customer”,
“__metadata”: {
“actions”: {
“http://hostname:port/sld/sld<version>.svc/$metadata#SLDEntities.AddUser”:
[
{
“target”:
“http://hostname:port/sld/sld<version>.svc/http://hostname:port/sld/sld<version>.svc/C
ustomers(25)/AddUser”,
“title”: “AddUser”
}
],
“http://hostname:port/sld/sld<version>.svc/$metadata#SLDEntities.RemoveUser”: [
{
“target”:
“http://hostname:port/sld/sld<version>.svc/http://hostname:port/sld/sld<version>.svc/C
ustomers(25)/RemoveUser”,
“title”: “RemoveUser”
}
]
},
“type”: “SLDModel.Customer”,
“uri”: “http://hostname:port/sld/sld<version>.svc/Customers(25)”
}
}
]
},
“actions”: {
“http://hostname:port/sld/sld<version>.svc/$metadata#SLDEntities.CreateCustomer”: [
{
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Customer API rights reserved. 57
“target”:
“http://hostname:port/sld/sld<version>.svc/Customers/CreateCustomer”,
“title”: “CreateCustomer”
}
]
}
}
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
58 rights reserved. Customer API
6 Tenant API
You can use the Tenant API to query tenant information, create new tenants, and update and delete tenants.
Creates a new tenant in the SLD with the information contained in the request body.
Note
Depending on the type of operator creating the tenant, the SLD performs the following actions:
o Reseller Operator – Automatically assigns the new tenant to the reseller to which the reseller
operator belongs.
o Cloud Operator – Does not automatically assign the new tenant to any resellers. The Cloud Operator
must use the Reseller API to manually assign the tenant to a reseller. For more information, see
Reseller API.
Property Description
Parameters None
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 59
Property Description
o CreationOption – Specifies how to create the tenant. The possible
values are:
o 0 – Create a default tenant.
o 1 – Create a tenant using a solution package.
o 2 – Create a tenant from a backup file.
o Name – The name of the company database. This attribute is
mandatory.
o Name – The name of the company.
o Country – Determines accounting related parameters, such as tax
definitions, tax reports, available chart of accounts templates, and
availability of country-specific features.
o ChartOfAccounts – The chart of accounts structure for the tenant.
For more information, see Listing Charts of Accounts.
o PeriodSubType – The number of additional posting periods that
SAP Business One creates automatically. The possible options are:
o Y – A single period during a fiscal year. SAP Business One will
not create additional posting periods automatically.
o Q – Four posting periods during a fiscal year.
o M – Twelve posting periods during a fiscal year.
o D – The number of posting periods during a fiscal year is
determined by the value of PeriodNumber.
o PeriodStartDate – The start date of the posting period.
o PeriodEndDate – The end date of the posting period.
o PeriodCode – A code of up to 20 characters for the posting period.
o PeriodName – A name of up to 20 characters for the posting period.
o PeriodNumber – The number of posting periods during a fiscal year.
If PeriodNumber is D, this attribute is mandatory.
o DefaultLang – The default language of the SAP Business One user
interface and display of default values, such as document series,
payment terms, and property descriptions.
o PackageFilePath – The file path of the solution package that you
want to use to create a tenant. If CreationOption is 1, this attribute is
mandatory.
o BackupFilePath – The file path of the backup file that you want to
use to create a tenant. If CreationOption is 2, this attribute is
mandatory.
Users – The user accounts to assign to the tenant. This is a complex
attribute that includes the following:
o SystemUsername – The Microsoft Windows domain user name for
the user account.
o SBOUsername – A unique code of up to 8 characters with which a
user logs on to the SAP Business One client application. The code is
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
60 rights reserved. Tenant API
Property Description
case sensitive and, once saved, cannot be changed.
o LicenseModules – A list of license modules assigned to the user.
ServiceUnit – The service unit in which you want to create a tenant. For
more information, see Listing Service Units. This is a complex attribute
that includes the following:
o ID – The automatically generated identification number of the
service unit. This attribute is mandatory.
LicenseFile – The license file to assign to the tenant. For more
information, see Listing License Files. This is a complex attribute that
includes the following:
o ID – The automatically generated identification number of the
license file.
Error Codes 501, 1001, 1002, 3000, 3014, 3018, 3112, 3127, 3128, 3132, 3134, 3135, 3138,
4105, 4107, 4108, 4201, 4202, 6003
Syntax
POST {
“Tenant”: {
“CompanyDatabase”: {
“ChartOfAccounts”: “A,AT_CoA”,
“Name”: “Tenant10”,
“Country”: “CN”,
“DefaultLang”: “3”,
“Name”: “Tenant10”,
“PeriodCode”: “1”,
“PeriodEndDate”: “20130529”,
“PeriodName”: “2”,
“PeriodNumber”: 1,
“PeriodStartDate”: “20120529”,
“PeriodSubType”: “Y”
},
“ContactPerson”: “ Adams “,
“CustomerID”: 28,
“Description”: “tenant for OEM Computers “,
“Email”: “ Marcus. Adams @oem.com “,
“LicenseFile”: {
“ID”: 1
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 61
},
“Phone”: “021-60001000”,
“Purpose”: “Demo”,
“ServiceUnit”: {
“ID”: 1
},
“Users”: [
{
“ID”: 6,
“IsSuperSBOUser”: true,
“LicenseModule”: [
{
“Type”: “OEM0000007051”
}
],
“SBOUsername”: “Customer”,
“Status”: “Active”,
“SystemUsername”: “Customer”
}
]
}
}
{
“d” : {
“CreateTenant” : ID
}
}
Retrieves information about an asynchronous operation. The SLD uses asynchronous operations to perform
tasks, such as creating tenants.
Property Description
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
62 rights reserved. Tenant API
Property Description
Syntax
GET https://hostname:port/sld/sld<version>.svc/GetAsyncOperationProperties?
OperationID=ID
{
"d": {
"GetAsyncOperationProperties": {
"__metadata": {
"type": "DBName.AsyncOperationPropertiesParam"
},
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 63
"OperationID": 479,
"OperationName": "CreateTenant",
"OperationStatus": "Processing",
"OperationProgress": 33
}
}
}
Deletes a tenant from the SLD, according to the identification number in the request URL.
Property Description
Parameters None
Syntax
DELETE https://hostname:port/sld/sld<version>.svc/Tenants(id)
Updates the information contained in the request body for a specified tenant, according to the identification
number in the request URL.
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
64 rights reserved. Tenant API
Property Description
implementation for a limited period.
o Productive – Customers can store company information and
perform business operations.
o Demo – Potential customers can try SAP Business One before
purchasing subscriptions.
o Testing – Cloud Operators can test new functionality and software
versions before customer deployment.
ContactPerson – The name of the contact person for the customer to
which this tenant is assigned.
Phone – The phone number of the contact person for the customer to
which this tenant is assigned.
Email – The email address of the contact person for the customer to
which this tenant is assigned.
Description – A description for this tenant.
LifeCycleStatus – The lifecycle status of the tenant. The possible values
are:
o Running – The tenant is operating normally and users can log on to
SAP Business One.
o Preupgrading – The service is currently performing a pre-upgrade
check on the tenant.
o Upgrading – The service is currently upgrading the tenant.
o Moving – The service is moving the tenant to a different service unit.
Status – The status of the tenant. The possible values are:
o Online – All users can log on to SAP Business One.
o Maintenance – Cloud Operators can log on to SAP Business One,
but SAP Business One Users cannot log on.
o Offline – All users cannot log on to SAP Business One.
Syntax
MERGE {
"ContactPerson": "Marcus. Adams",
"Description": "OEM supplier for US. Head office in Washington",
"Email": " Marcus. Adams @oem.com",
"LifeCycleStatus": "Running",
"Phone": "021-6000-1000",
"Status": "Online"
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 65
6.5 Listing Tenants
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
66 rights reserved. Tenant API
Property Description
SBOSharedFolder – The dedicated shared folder, in which attachments,
images, and document templates are stored, assigned to the tenant.
For more information, see Error! Reference source not found..
LicenseFile – The license file assigned to the tenant. For more
information, see Listing License Files.
ServiceUnit – The service unit to which the tenant belongs. For more
information, see Listing Service Units.
CompanyDatabase – The company database assigned to the tenant.
Syntax
GET https://hostname:port/sld/sld<version>.svc/Tenants
{
“d”: {
“CompanyDatabase”: {
“__deferred”: {
“uri”: “http://HOSTNAME:port/sld/sld<version>.svc/Tenants(3)/CompanyDatabase”
}
},
“ContactPerson”: “ Adams “,
“Customer”: {
“__deferred”: {
“uri”: “http://HOSTNAME:port/sld/sld<version>.svc/Tenants(3)/Customer”
}
},
“Description”: “ tenant for OEM Computers “,
“Email”: “ Marcus. Adams @oem.com “,
“Group”: {
“ID”: 10,
“Name”: “Tenant_3_Group”,
“Roles”: {
“__deferred”: {
“uri”: “http://HOSTNAME:port/sld/sld<version>.svc/Groups(10)/Roles”
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 67
},
“Users”: {
“__deferred”: {
“uri”: “http://HOSTNAME:port/sld/sld<version>.svc/Groups(10)/Users”
}
},
“__metadata”: {
“functions”: {
“http://HOSTNAME:port/sld/sld<version>.svc/$metadata#SLDEntities.GetAllUsers”: [
{
“target”:
“http://HOSTNAME:port/sld/sld<version>.svc/http://HOSTNAME:port/sld/sld<version>.svc/G
roups(10)/GetAllUsers”,
“title”: “GetAllUsers”
}
]
},
“type”: “databaseName.Group”,
“uri”: “http://HOSTNAME:port/sld/sld<version>.svc/Groups(10)”
}
},
“ID”: 3,
“LicenseFile”: {
“__deferred”: {
“uri”: “http://HOSTNAME:port/sld/sld<version>.svc/Tenants(3)/LicenseFile”
}
},
“LifeCycleStatus”: “Running”,
“Phone”: “021-60001000”,
“Purpose”: “Trial”,
“SBOSharedFolder”: {
“__deferred”: {
“uri”: “http://HOSTNAME:port/sld/sld<version>.svc/Tenants(3)/SBOSharedFolder”
}
},
“ServiceUnit”: {
“__deferred”: {
“uri”: “http://HOSTNAME:port/sld/sld<version>.svc/Tenants(3)/ServiceUnit”
}
},
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
68 rights reserved. Tenant API
“Status”: “Online”,
“__metadata”: {
“actions”: {
“http://HOSTNAME:port/sld/sld<version>.svc/$metadata#SLDEntities.BindUser”: [
{
“target”:
“http://HOSTNAME:port/sld/sld<version>.svc/http://HOSTNAME:port/sld/sld<version>.svc/T
enants(3)/BindUser”,
“title”: “BindUser”
}
],
“http://HOSTNAME:port/sld/sld<version>.svc/$metadata#SLDEntities.UnbindUser”:
[
{
“target”:
“http://HOSTNAME:port/sld/sld<version>.svc/http://HOSTNAME:port/sld/sld<version>.svc/T
enants(3)/UnbindUser”,
“title”: “UnbindUser”
}
],
“http://HOSTNAME:port/sld/sld<version>.svc/$metadata#SLDEntities.UpdateUser”:
[
{
“target”:
“http://HOSTNAME:port/sld/sld<version>.svc/http://HOSTNAME:port/sld/sld<version>.svc/T
enants(3)/UpdateUser”,
“title”: “UpdateUser”
}
]
},
“functions”: {
“http://HOSTNAME:port/sld/sld<version>.svc/$metadata#SLDEntities.GetActiveConnectionCo
unt”: [
{
“target”:
“http://HOSTNAME:port/sld/sld<version>.svc/http://HOSTNAME:port/sld/sld<version>.svc/T
enants(3)/GetActiveConnectionCount”,
“title”: “GetActiveConnectionCount”
}
],
“http://HOSTNAME:port/sld/sld<version>.svc/$metadata#SLDEntities.GetUsers”: [
{
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 69
“target”:
“http://HOSTNAME:port/sld/sld<version>.svc/http://HOSTNAME:port/sld/sld<version>.svc/T
enants(3)/GetUsers”,
“title”: “GetUsers”
}
]
},
“type”: “SLDModel.Tenant”,
“uri”: “http://HOSTNAME:port/sld/sld<version>.svc/Tenants(3)”
}
}
}
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
70 rights reserved. Tenant API
Property Description
versions before customer deployment.
Tenants – A list of tenants belonging to the service unit.
ApplicationServers – A list of presentation servers assigned to the
service unit.
LicenseServer – The license server assigned to the service unit.
SoftwareRepository – The software repository assigned to the service
unit.
RSPService – The remote support platform instance that monitors the
service unit.
Mailer – The mailer service assigned to the service unit.
IntegrationComponent – The integration component assigned to this
service unit.
CommonDatabase – The common database assigned to the service
unit.
CompanyTemplateRepository – The location to store backup files
containing template company databases.
ImplementationRepository – The location to store solution packages.
SharedFolder – A dedicated shared folder, in which attachments,
images, and document templates are stored.
Group – The service unit group, which contains all user accounts of
tenants assigned to the service unit.
Syntax
GET https://hostname:port/sld/sld<version>.svc/ServiceUnits
{
“actions”: {
“http://hostname:port/sld/sld<version>.svc/$metadata#SLDEntities.CreateServiceUnit”: [
{
“target”:
“http://hostname:port/sld/sld<version>.svc/ServiceUnits/CreateServiceUnit”,
“title”: “CreateServiceUnit”
}
]
},
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 71
“d”: {
“results”: [
{
“ApplicationServers”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/ApplicationServers”
}
},
“CommonDatabase”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/CommonDatabase”
}
},
“CompanyTemplateRepository”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/CompanyTemplateRepository”
}
},
“SharedFolder”: {
"__deferred”: {
“uri”: “http://hostname:8080/sld/sld0100.svc/ServiceUnits(1)/SharedFolder”
}
},
“Description”: “description “,
“Group”: {
“__deferred”: {
“uri”: “http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/Group”
}
},
“ID”: 1,
“ImplementationRepository”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/ImplementationRepository”
}
},
“IntegrationComponent”: {
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
72 rights reserved. Tenant API
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/IntegrationComponent”
}
},
“LicenseServer”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/LicenseServer”
}
},
“Mailer”: {
“__deferred”: {
“uri”: “http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/Mailer”
}
},
“Mode”: “Normal”,
“Name”: “OEM COMPUTERS “,
“Purpose”: “Demo”,
“RSPService”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/RSPService”
}
},
“SoftwareRepository”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/SoftwareRepository”
}
},
“Status”: “Online”,
“Tenants”: {
“__deferred”: {
“uri”: “http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)/Tenants”
}
},
“Version”: “1.0”,
“__metadata”: {
“type”: “Dbname.ServiceUnit”,
“uri”: “http://hostname:port/sld/sld<version>.svc/ServiceUnits(1)”
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 73
}
}
]
}
}
Property Description
Parameters None
Syntax
GET https://hostname:port/sld/sld<version>.svc/LicenseFiles
{
“d”: {
“results”: [
{
“FileName”: “OEM-INTERN”,
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
74 rights reserved. Tenant API
“ID”: 1,
“InstallationNumber”: “Your installation number”,
“LicenseServer”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/LicenseFiles(1)/LicenseServer”
}
}, “Localization”: “Shanghai”, “Version”: “9.0”,
“__metadata”: {
“functions”: {
“http://hostname:port/sld/sld<version>.svc/$metadata#SLDEntities.GetLicenseModules”: [
{
“target”:
“http://hostname:port/sld/sld<version>.svc/http://hostname:port/sld/sld<version>.svc/L
icenseFiles(1)/GetLicenseModules”,
“title”: “GetLicenseModules”
}
],
“http://hostname:port/sld/sld<version>.svc/$metadata#SLDEntities.GetLicenseModulesBySB
OUser”: [
{
“target”:
“http://hostname:port/sld/sld<version>.svc/http://hostname:port/sld/sld<version>.svc/L
icenseFiles(1)/GetLicenseModulesBySBOUser”,
“title”: “GetLicenseModulesBySBOUser”
}
]
},
“type”: “SLDModel.LicenseFile”,
“uri”: “http://hostname:port/sld/sld<version>.svc/LicenseFiles(1)”
}
}
]
}
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 75
6.8 Listing Languages
Retrieves a list of supported languages for a specified software repository, according to the identification number
in the request URL.
Property Description
Parameters None
Syntax
GET
https://hostname:port/sld/sld<version>.svc/SoftwareRepositories(id)/GetLanguageList
{
"d": {
"results": [
"Japanese(Japan),30",
"Danish (Denmark),11",
"French,22",
"Spanish (Latin America),25",
"Polish (Poland),5",
"Finnish (Finland),17",
"English (United States),3",
"Czech (Czech),26",
"Portuguese (Brazil),29",
"Hebrew (Israel),1",
"Russian (Russia),24",
"Slovak (Slovakia),27",
"Dutch (Netherlands),16",
"Swedish (Sweden),20",
"Turkish,31",
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
76 rights reserved. Tenant API
"English (United Kingdom),8",
"Arabic,32",
"Portuguese,19",
"Greek (Greece),18",
"Korean(Korea),28",
"Traditional Chinese,35",
"Spanish (Spain),23",
"Italian (Italy),13",
"Simplified Chinese (P.R.China),15",
"Norwegian (Norway),12",
"Hungarian (Hungary),14",
"German,9"
]
}
}
Retrieves a list of supported charts of accounts for a specified common database, according to the identification
number in the request URL, and a specified localization.
Property Description
Parameters Localization – The country code of the tenant. For more information, see
Listing Localizations. This attribute is mandatory.
Syntax
GET https://hostname:port/sld/sld<version>.svc/CommonDatabases(id)/
GetChartOfAccountList? Localization=’XX’
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 77
Sample Response Body
{
“d”: {
“results”: [
“M,Information “
]
}
}
Retrieves a list of support localizations for specified common database, according to the identification number in
the request URL.
Property Description
Parameters None
Syntax
GET https://hostname:port/sld/sld<version>.svc/CommonDatabases(id)/GetLocalizationList
{
“d”: {
“results”: [
“AT,Austria”,
“AU,Australia/New Zealand”,
“BE,Belgium”,
“BR,Brazil”,
“CA,Canada”,
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
78 rights reserved. Tenant API
“CH,Switzerland”,
“CL,Chile”,
“CN,P.R.China”,
“CR,Costa Rica”,
]
}
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant API rights reserved. 79
7 Tenant User API
You can use the Tenant User API to register new users, bind users to a tenant, update users’ information, and
remove users from a tenant.
Adds a user with the information contained in the request body to a specified tenant, according to the
identification number in the request URL. To first create a new user then bind the user to a tenant, set Force to
true.
Property Description
Parameters None
Note
The attributes that you specify must be consistent with the
information in the SLD, otherwise the SLD returns an error.
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
80 rights reserved. Tenant User API
Property Description
If you specify only SystemUsername, the SLD creates a new active
user account.
If you specify SystemUsername and Status, the SLD creates a new
user account with the corresponding status.
Error Codes 502, 3125, 3138, 3200, 4000, 4006, 4012, 4021, 4107, 4108, 4203, 4204,
4205, 8202
Syntax
POST {
{
"Users": [
{
"SystemUsername": "Adams",
"SboUsername": "Adams",
"IsSuperSBOUser": false,
"Status": "Active"
}
]
}
Removes a user contained in the request body from a specified tenant, according to the identification number in
the request URL.
Property Description
Parameters None
Request Body UserID – The automatically generated identification number of the user that
you want to unbind. This attribute is mandatory.
Response Body If the unbinding is successful, the value is true. Otherwise, the value is false.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant User API rights reserved. 81
Syntax
POST {“UserID”:21}
{
“d” : {
“UnbindUser” : true
}
}
Updates the user information contained in the request body for a specified tenant, according to the identification
number in the request URL. You can also assign and remove licenses for a user.
Property Description
Parameters None
Note
If you specify an empty array for LicenseModules, the SLD
unassigns all licenses from the user.
Response Body If the update is successful, the value is true. Otherwise, the value is false.
Error Codes 305, 502, 3134, 4000, 4012, 4015, 4023, 4108
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
82 rights reserved. Tenant User API
Syntax
POST {
"Users": [
{
"ID": 1,
"SBOUsername": " Adams ",
"Status": "Inactive",
"LicenseModule": [],
"IsSuperSBOUser": false
}
]
}
{
“d” : {
“UpdateUser” : true
}
}
Retrieves a list of all users and their license assignments for a specified tenant, according to the identification
number in the request URL.
Property Description
Parameters None
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant User API rights reserved. 83
Property Description
SystemUsername – The Microsoft Windows domain user name for the
user account.
SBOUsername – A unique code of up to 8 characters with which a user
logs on to the SAP Business One client application. The code is case
sensitive and, once saved, cannot be changed.
IsSuperSBOUser – Indicates whether the user has superuser
permissions.
LicenseModules – A list of license modules assigned to the user. This is
a complex attribute that includes the following:
o Type – The type of license module.
o Description – A description for the license module.
Roles – A list of roles assigned to the user. This is a complex attribute
that includes the following:
o ID – The automatically generated identification number of the role.
o Name – The name of the role. The possible values are:
o Cloud Operator
o SAP Business One User
o Reseller
Syntax
GET https://hostname:port/sld/sld<version>.svc/Tenants(id)/GetUsers
{
“d”: {
“results”: [
{
“__metadata”: {
“type”: “DBName.CTUser”
},
“ID”: 6,
“Status”: “Active”,
“SystemUsername”: “ B1OD/Adams “,
“SBOUsername”: “ Adams “,
“IsSuperSBOUser”: false,
“LicenseModules”: {
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
84 rights reserved. Tenant User API
“results”: [
]
},
“roles”: {
“results”: [
{
“__metadata”: {
“type”: “DBName.CTRole”
},
“ID”: 2,
“Name”: “OEM User”
}
]
}
}
]
}
}
Adds a user to a specified customer, according to the identification number in the request URL.
Property Description
Parameters None
Note
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant User API rights reserved. 85
Property Description
Recommendation
To add a new user account, specify only SystemUsername and
Status. To add an existing user to a customer, specify only ID and
SystemUsername.
Error Codes 303, 305, 502, 4006, 4021, 4203, 4204, 4205, 8202
Syntax
Property Description
Parameters None
Request Body UserID – The automatically generated identification number of the user you
want to remove.
Response Body If the removal is successful, the value is true. Otherwise, the value is
false.
Syntax
POST {“UserID”:id}
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
86 rights reserved. Tenant User API
Sample Response Body
{
“d” : {
“RemoveUser” : true
}
}
Property Description
Parameters None
Syntax
GET https://hostname:port/sld/sld<version>.svc/Users
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant User API rights reserved. 87
“d”: {
“results”: [
{
“__metadata”: {
“type”: “DBName.UserParam”
},
“ID”: 21,
“IsSuperSBOUser”: false,
“LicenseModules”: {
“results”: [
]
},
“Roles”: {
“results”: [
{
“__metadata”: {
“type”: “DBName.RoleParam”
},
“ID”: 2,
“Name”: “OEM User”
}
]
},
“SBOUsername”: “Adams “,
“Status”: “Active”,
“SystemUsername”: “B1OD/Adams “
}
]
}
}
Retrieves a list of all Microsoft Windows domain user accounts in the SLD and their user account bindings.
Property Description
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
88 rights reserved. Tenant User API
Property Description
Parameters None
Syntax
GET https://hostname:port/sld/sld<version>.svc/SystemUserBindings
{
“d”: {
“results”: [
{
“ID”: 1,
“SystemUser”: “ Adams “,
“User”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/SystemUserBindings(1)/User”
}
},
“__metadata”: {
“type”: “SLDModel.SystemUserBinding”,
“uri”: “http://hostname:port/sld/sld<version>.svc/SystemUserBindings(1)”
}
},
“functions”: {
“http://hostname:port/sld/sld<version>.svc/$metadata#SLDEntities.FindCustomer”: [
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant User API rights reserved. 89
{
“target”:
“http://hostname:port/sld/sld<version>.svc/SystemUserBindings/FindCustomer”,
“title”: “FindCustomer”
}
]
}
}
Retrieves a list of all SAP Business One Users in the SLD and their associated information.
Property Description
Parameters None
Syntax
GET https://hostname:port/sld/sld<version>.svc/SBOUserBindings
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
90 rights reserved. Tenant User API
Sample Response Body
{
“d”: {
“results”: [
{
“CompanyDatabase”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/SBOUserBindings(4)/CompanyDatabase”
}
},
“Confirmed”: null,
“ID”: 4,
“IsSuperuser”: true,
“SBOUsername”: “ Adams “,
“User”: {
“__deferred”: {
“uri”: “http://hostname:port/sld/sld<version>.svc/SBOUserBindings(4)/User”
}
},
“__metadata”: {
“type”: “DBName.SBOUserBinding”,
“uri”: “http://hostname:port/sld/sld<version>.svc/SBOUserBindings(4)”
}
}
]
}
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Tenant User API rights reserved. 91
8 License Assignment API
You can use the License Assignment API to retrieve licenses from a license server.
Retrieves a list of license modules and their associated information for the license file specified by the
identification number in the request URL.
Property Description
Parameters None
Response Body This function returns a list of license modules, each with the following
attributes:
ID – The automatically generated identification number of the license
module.
Total – The total number of license modules in the license file.
LicenseFile – The license file to which the license module belongs.
Available – The number of unassigned license modules in the license
file.
Type – The type of license module.
ExpirationDate – The expiration date of the license module.
StartDate – The start date of the license module.
IsExpired – Indicates whether the license module is expired.
InstallationNumber – The installation number of the license file to which
the license module belongs.
Description – A description for the license module.
Syntax
GET https://hostname:port/sld/sld<version>.svc/LicenseFiles(id)/GetLicenseModules
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
92 rights reserved. License Assignment API
Sample Response Body
{
“d”: {
“results”: [
{
“Available”: 0,
“Description”: “license for OEM”,
“ExpirationDate”: “/Date(1358179200000)/”,
“ID”: 1,
“InstallationNumber”: “OEM-INTERN”,
“IsExpired”: false,
“LicenseFile”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/LicenseModules(1)/LicenseFile”
}
},
“StartDate”: “/Date(1334246400000)/”,
“Total”: 1,
“Type”: “licenseType”,
“__metadata”: {
“type”: “DBName.LicenseModule”,
“uri”: “http://hostname:port/sld/sld<version>.svc/LicenseModules(1)”
}
}
]
}
Retrieves a list of license modules per a specified customer and their associated information for the license file
specified by the identification number in the request URL.
Property Description
Parameters None
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
License Assignment API rights reserved. 93
Property Description
Response Body This function returns a list of license modules per a specific customer, each
with the following attributes:
ID – The automatically generated identification number of the license
module.
Total – The total number of license modules in the license file.
LicenseFile – The license file to which the license module belongs.
Available – The number of unassigned license modules in the license
file.
Type – The type of the license module.
ExpirationDate – The expiration date of the license module.
StartDate – The start date of the license module.
IsExpired – Indicates whether the license module is expired.
InstallationNumber – The installation number of the license file to which
the license module belongs.
Description – A description for the license module.
TotalQuota – The total number of license assignments set for a
customer.
Syntax
GET https://hostname:port/sld/sld<version>.svc/LicenseFiles(id)/
GetLicenseModulesPerCustomer?CustomerID=ID
{
“d”: {
“results”: [
{
“__metadata”: {
“type”: “SLDModel.LicenseModule”,
“uri”: “http://hostname:port/sld/sld<version>.svc/LicenseModules(1)”
}
"Total": 50,
“ID”: 1,
“InstallationNumber”: “OEM-INTERN”,
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
94 rights reserved. License Assignment API
“StartDate”: “/Date(1358179200000)/”,
“Description”: 1,
“ExpirationDate”: “/Date(1334246400000)/”,
“TotalQuota”: 50,
“IsExpired”: false,
“Available”: 23,
“Type”: ”PROFESSIONAL”
“LicenseFile”: {
“__deferred”: {
“uri”:
“http://hostname:port/sld/sld<version>.svc/LicenseModules(1)/LicenseFile”
}
}
}
]
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
License Assignment API rights reserved. 95
9 Trial Request API
You can use the Trial Request API to create, update, and retrieve information about trial requests.
For customers that are interested in learning more about SAP Business One Cloud, you can offer a fully functional
license-free trial. During the trial period, customers can access a simple SAP Business One implementation, for a
limited time and number of users.
After a customer requests a trial, the application creates a new trial request in the SLD. An SLD operator can
review the trial request and do either of the following:
Reject the trial request by setting the status to Rejected.
Approve the trial request by setting the status to InProcess, then preparing a trial tenant. When the trial
tenant is ready, the SLD operator can release the trial tenant to the customer.
Note
If an error occurs while processing the trial request, the application sets the status of the trial request to
Failed. An SLD operator can evaluate the error, and then continue to process the trial request.
Creates a new trial request in the SLD with the information contained in the request body.
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
96 rights reserved. Trial Request API
Property Description
Location – The address of the trial customer. This attribute is
mandatory.
Industry – The industry in which the trial customer operates. This
attribute is mandatory.
EmployeeCount – The number of people that the trial customer
employs.
Reason – The reason given by the customer for requesting a trial.
UserData1, UserData2, UserData3, UserData4, UserData5, UserData6,
UserData7, UserData8, UserData9, UserData10 – Reserved for custom
functionality.
Syntax
POST {
"Name": "OEM Computers",
"ContactPerson": "Adams Marcus ",
"Phone": "021-60001000",
"Email": "Marcus. Adams @oem.com ",
"Industry": "IT",
"Country": "USA",
"State": "NW",
"Location": "1600 Pennsylvania Avenue, NW Washington, DC 20500 ",
"PostalCode": "212121",
"EmployeeCount": 100,
"Reason": "Request a tenant for OEM supplier"
}
Updates the information contained in the request body for a specified trial request, according to the identification
number in the request URL.
Property Description
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Trial Request API rights reserved. 97
Property Description
Parameters None
Syntax
MERGE {
"RequestStatus ": "InProcess",
"Phone": "00-1-202-60001000",
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
98 rights reserved. Trial Request API
}
Property Description
Parameters None
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Trial Request API rights reserved. 99
Property Description
Comments – Comments on the trial request.
Processor – The SLD operator responsible for processing the trial
request.
CustomerID – The automatically generated identification number of the
trial customer.
UserData1, UserData2, UserData3, UserData4, UserData5, UserData6,
UserData7, UserData8, UserData9, UserData10 – Reserved for custom
functionality.
Syntax
GET https://hostname:port/sld/sld<version>.svc/TrialRequests
{
"d": {
"results": [
{
"__metadata": {
"uri": "http://hostname:port/sld/sld0100.svc/TrialRequests(1)",
"type": "SLDModel.TrialRequest",
"actions": {
"http://hostname:port/sld/sld0100.svc/$metadata#SLDEntities.AbortInProcessTrialRequest
": [
{
"target":
"http://hostname:port/sld/sld0100.svc/http://hostname:port/sld/sld0100.svc/TrialReques
ts(1)/AbortInProcessTrialRequest",
"title": "AbortInProcessTrialRequest"
}
]
}
},
"PostalCode": "212121",
"Phone": "00-1-202-60001000",
"Reason": "daadda",
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
100 rights reserved. Trial Request API
"UserData10": null,
"State": "Request a tenant for OEM supplier ",
"LastModifiedDate": "\/Date(1342590984507)\/",
"RequestDate": "\/Date(1342590984450)\/",
"ID": 1,
"UserData1": null,
"UserData2": null,
"UserData3": null,
"UserData4": null,
"Industry": "IT",
"UserData9": null,
"RequestStatus": "New",
"UserData8": null,
"UserData7": null,
"UserData6": null,
"UserData5": null,
"Name": "OEM Computers ",
"EmployeeCount": 100,
"Country": "USA",
"ContactPerson": "Adams Marcus ",
"Location": "1600 Pennsylvania Avenue, NW Washington, DC 20500",
"Email": "Marcus. Adams @oem.com",
"Comments": null,
"Processor": null,
"Customer": {
"__deferred": {
"uri": "http://hostname:port/sld/sld0100.svc/TrialRequests(1)/Customer"
}
}
}
]
},
"actions": {
"http://hostname:port/sld/sld0100.svc/$metadata#SLDEntities.AbortInProcessTrialRequest
": [
{
"target":
"http://hostname:port/sld/sld0100.svc/TrialRequests/AbortInProcessTrialRequest",
"title": "AbortInProcessTrialRequest"
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Trial Request API rights reserved. 101
]
}
}
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
102 rights reserved. Trial Request API
10 Reseller API
You can use this API to create, update, and delete resellers. You can also assign resources such as service units,
customers, and licenses to resellers.
Property Description
Parameters None
Response Body CheckResellerStatus – Boolean value that indicates the status of the reseller
to which you are assigned. The possible values are:
True – The status of the reseller to which you are assigned is Online.
You can log on to the Cloud Control Center.
False – The status of the reseller to which you are assigned is Offline.
You cannot log on to the Cloud Control Center.
{
"CheckResellerStatus" : true
}
Creates a new reseller in the SLD with the information contained in the request body.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 103
Property Description
Parameters None
Request Body Name – The name of the reseller. This attribute is mandatory.
ServiceUnits –A list of service units to assign to the reseller, This is a
complex attribute that includes the following:
o ID – The automatically generated identification number of the
service unit
Users – A list of users to assign to the reseller, This is a complex
attribute that includes the following:
o SystemUsername– The Microsoft Windows domain user name for
the user account.
o Status – The status of a user, The possible values are:
o Active – The user can log on to SAP Business One.
o Inactive – The user cannot log on to SAP Business One. You can
change a user’s status to Active later.
Syntax
POST {
"Reseller":{
"Name":"NewResella",
"Users":[
{
"SystemUsername":"user4",
"Status":"Active"
}
],
"ServiceUnits":[
{
"ID":3
}
]
}
}
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
104 rights reserved. Reseller API
10.3 Assigning Resources
You can assign a single resource to a reseller or assign multiple resources in batches.
Assigns a single resource to a specified reseller, according to the type and identification number in the request
body.
Property Description
Parameters None
Request Body ResourceType – The type of resource to assign to the reseller. The
possible values are:
o ServiceUnit
o Customer
o License
ResourceID – The automatically generated identification number of the
resource to assign to the reseller.
Syntax
POST {
"ResourceType":"ServiceUnit",
"ResourceIDs": [4
}
Assigns a list of resources to a specified reseller, according to the types and identification numbers in the request
body.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 105
Property Description
Parameters None
Request Body ResourceType – The type of resources to assign to the reseller. The
possible values are:
o ServiceUnit
o Customer
o License
ResourceIDs – A list of automatically generated identification numbers
of all the resources to assign to the reseller.
Syntax
POST {
"ResourceType":"ServiceUnit",
"ResourceIDs":[
4
]
}
You can unassign a single resource from a reseller or unassign multiple resources in batches.
Unassigns a single resource from a specified reseller, according to the type and identification number in the
request body.
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
106 rights reserved. Reseller API
Property Description
Request Body ResourceType – The type of resource to unassign from the reseller. The
possible values are:
o ServiceUnit
o Customer
o License
ResourceID – The automatically generated identification number of the
resource to unassign from the reseller.
Syntax
POST {
"ResourceType":"ServiceUnit",
"ResourceIDs": 4
}
Unassigns a list of resources from a specified reseller, according to the type and identification number in the
request body.
Property Description
Parameters None
Request Body ResourceType – The type of resources to assign to the reseller. The
possible values are:
o ServiceUnit
o Customer
o License
ResourceIDs – A list of automatically generated identification numbers
of all the resources to unassign from the reseller.
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 107
Property Description
Syntax
POST {
"ResourceType":"ServiceUnit",
"ResourceIDs":[
4
]
}
Property Description
Parameters None
Adds a user to a specified reseller, according to the identification number in the request URL.
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
108 rights reserved. Reseller API
Property Description
ID – The automatically generated identification number of the user.
Status – The status of the user account. The possible values are:
o Active – The user can log on to SAP Business One.
o Inactive – The user cannot log on to SAP Business One. You can
change a user’s status to Active later.
SystemUsername – The Microsoft Windows domain user name for the
user account.
Syntax
POST {
"Reseller":{
"ID":2
},
"User":{
"SystemUsername":"resellerc",
"Status":"Active",
"Deleted":false
}
}
Property Description
Parameters None
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 109
Property Description
SystemUsername – The Microsoft Windows domain user name for the
user account.
Syntax
POST {
"Reseller":{
"ID":2
},
"User":{
"SystemUsername":"resellerc",
"Status":"Active",
"Deleted":false
}
}
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
110 rights reserved. Reseller API
Property Description
o Online – Users of the reseller can log on to SAP Business One.
o Offline – Users of the reseller cannot log on to SAP Business One.
Description – A description for this reseller.
Syntax
GET https://hostname:port/sld/sld<version>.svc/Resellers
{
"d":{
"results":[
{
"__metadata":{
"uri":"http://localhost:9080/sld/sld0100.svc/Resellers(1)",
"type":"SLDModel.Reseller"
},
"ID":1,
"Phone":null,
"ContactPerson":null,
"Status":"Online",
"Email":null,
"Description":null,
"Name":"resellera",
"Location":null,
"CreationDate":"\/Date(1348606254473)\/",
"EmployeeCount":null,
"Country":null,
"Group":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Resellers(1)/Group"
}
}
}
]
},
"actions":{
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.CreateReseller":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/CreateReseller",
"title":"CreateReseller"
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 111
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.RemoveReseller":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/RemoveReseller",
"title":"RemoveReseller"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.AssignResources":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/AssignResources"
,
"title":"AssignResources"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.UnassignResources":
[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/UnassignResource
s",
"title":"UnassignResources"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.AssignResource":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/AssignResource",
"title":"AssignResource"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.UnassignResource":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/UnassignResource
",
"title":"UnassignResource"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.AddUserToReseller":
[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/AddUserToReselle
r",
"title":"AddUserToReseller"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.RemoveUserFromResel
ler":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/RemoveUserFromRe
seller",
"title":"RemoveUserFromReseller"
}
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
112 rights reserved. Reseller API
]
},
"functions":{
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.GetServiceUnitsOfRe
seller":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/GetServiceUnitsO
fReseller",
"title":"GetServiceUnitsOfReseller"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.GetCustomersOfResel
ler":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/GetCustomersOfRe
seller",
"title":"GetCustomersOfReseller"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.GetLicensesOfResell
er":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Resellers/GetLicensesOfRes
eller",
"title":"GetLicensesOfReseller"
}
]
}
}
Retrieves a list of all service units assigned to the reseller in the SLD.
Property Description
Parameters None
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 113
Property Description
o Online – Users can log on to SAP Business One.
o Offline – Users cannot log on to SAP Business One.
Name – A unique name of up to 128 characters for the service unit.
Version – The version of SAP Business One that customers run in the
service unit.
Description – A description for the service unit.
Purpose – The purpose of the service unit. The possible values are:
o Trial – Customers can evaluate a dedicated SAP Business One
implementation for a limited period.
o Productive – Customers can store company information and
perform business operations.
o Demo – Potential customers can try SAP Business One before
purchasing subscriptions.
o Testing – Cloud Operators can test new functionality and software
versions before customer deployment.
Tenants – A list of tenants belonging to the service unit.
ApplicationServers – A list of presentation servers assigned to the
service unit.
LicenseServer – The license server assigned to the service unit.
SoftwareRepository – The software repository assigned to the service
unit.
RSPService – The remote support platform instance that monitors the
service unit.
Mailer – The mailer service assigned to the service unit.
IntegrationComponent – The integration component assigned to this
service unit.
CommonDatabase – The common database assigned to the service
unit.
CompanyTemplateRepository – The location to store backup files
containing template company databases.
ImplementationRepository – The location to store solution packages.
SharedFolder – A dedicated shared folder, in which attachments,
images, and document templates are stored.
Group – The service unit group, which contains all user accounts of
tenants assigned to the service unit.
Syntax
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
114 rights reserved. Reseller API
Sample Response Body
{
"d" : {
"results" : [
{
"__metadata" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)", "type" :
"SLDModel.ServiceUnit"
}, "Status" : "Online", "Purpose" : "Demo", "CreationDate" :
"\/Date(1348517125077)\/", "Mode" : "", "Version" : "882.071.08", "ID" : 3,
"Description" : null, "Name" : "SUA1", "CommonDatabase" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/CommonDatabase"
}
}, "LicenseServer" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/LicenseServer"
}
}, "ImplementationRepository" : {
"__deferred" : {
"uri" :
"http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/ImplementationRepository"
}
}, "IntegrationComponent" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/IntegrationComponent"
}
}, "SharedFolder" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/SharedFolder"
}
}, "Mailer" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/Mailer"
}
}, "SoftwareRepository" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/SoftwareRepository"
}
}, "Group" : {
"__deferred" : {
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 115
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/Group"
}
}, "TenantsStorage" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/TenantsStorage"
}
}, "RSPService" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/RSPService"
}
}, "ReferenceServiceUnit" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/ReferenceServiceUnit"
}
}, "CompanyTemplateRepository" : {
"__deferred" : {
"uri" :
"http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/CompanyTemplateRepository"
}
}, "Tenants" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/Tenants"
}
}, "PresentationServers" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(3)/PresentationServers"
}
}
}, {
"__metadata" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)", "type" :
"SLDModel.ServiceUnit"
}, "Status" : "Online", "Purpose" : "Demo", "CreationDate" :
"\/Date(1348517198080)\/", "Mode" : "", "Version" : "882.071.08", "ID" : 4,
"Description" : null, "Name" : "SUB1", "CommonDatabase" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/CommonDatabase"
}
}, "LicenseServer" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/LicenseServer"
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
116 rights reserved. Reseller API
}
}, "ImplementationRepository" : {
"__deferred" : {
"uri" :
"http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/ImplementationRepository"
}
}, "IntegrationComponent" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/IntegrationComponent"
}
}, "SharedFolder" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/SharedFolder"
}
}, "Mailer" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/Mailer"
}
}, "SoftwareRepository" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/SoftwareRepository"
}
}, "Group" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/Group"
}
}, "TenantsStorage" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/TenantsStorage"
}
}, "RSPService" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/RSPService"
}
}, "ReferenceServiceUnit" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/ReferenceServiceUnit"
}
}, "CompanyTemplateRepository" : {
"__deferred" : {
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 117
"uri" :
"http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/CompanyTemplateRepository"
}
}, "Tenants" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/Tenants"
}
}, "PresentationServers" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(4)/PresentationServers"
}
}
}, {
"__metadata" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)", "type" :
"SLDModel.ServiceUnit"
}, "Status" : "Online", "Purpose" : "Demo", "CreationDate" :
"\/Date(1348518680213)\/", "Mode" : "", "Version" : "882.071.08", "ID" : 5,
"Description" : null, "Name" : "SUA2", "CommonDatabase" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/CommonDatabase"
}
}, "LicenseServer" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/LicenseServer"
}
}, "ImplementationRepository" : {
"__deferred" : {
"uri" :
"http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/ImplementationRepository"
}
}, "IntegrationComponent" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/IntegrationComponent"
}
}, "SharedFolder" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/SharedFolder"
}
}, "Mailer" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/Mailer"
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
118 rights reserved. Reseller API
}
}, "SoftwareRepository" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/SoftwareRepository"
}
}, "Group" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/Group"
}
}, "TenantsStorage" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/TenantsStorage"
}
}, "RSPService" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/RSPService"
}
}, "ReferenceServiceUnit" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/ReferenceServiceUnit"
}
}, "CompanyTemplateRepository" : {
"__deferred" : {
"uri" :
"http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/CompanyTemplateRepository"
}
}, "Tenants" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/Tenants"
}
}, "PresentationServers" : {
"__deferred" : {
"uri" : "http://localhost:9080/sld/sld0100.svc/ServiceUnits(5)/PresentationServers"
}
}
}
]
}, "actions" : {
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.CreateServiceUnitAsync" :
[
{
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 119
"target" :
"http://localhost:9080/sld/sld0100.svc/ServiceUnits/CreateServiceUnitAsync", "title" :
"CreateServiceUnitAsync"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.RegisterPresentationServe
rAsync" : [
{
"target" :
"http://localhost:9080/sld/sld0100.svc/ServiceUnits/RegisterPresentationServerAsync",
"title" : "RegisterPresentationServerAsync"
}
]
}, "functions" : {
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.GetDeployableExtensions"
: [
{
"target" :
"http://localhost:9080/sld/sld0100.svc/ServiceUnits/GetDeployableExtensions", "title"
: "GetDeployableExtensions"
}
]
}
}
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
120 rights reserved. Reseller API
Property Description
o TrialCustomer – A customer that wants to evaluate SAP Business
One Cloud before purchasing a subscription.
o Customer – A customer that has purchased as subscription for SAP
Business One Cloud. By default, the value is Customer.
ContactPerson – The name of the customer’s contact person.
Phone – The phone number of the customer’s contact person.
Email – The email address of the customer’s contact person.
Location – The address of the customer.
Country – The country in which the customer is located.
Industry – The industry in which the customer operates.
EmployeeCount – The number of people that the customer employs.
Status – The status of the customer. The possible values are:
o Online – Users of the customer can log on to SAP Business One.
o Offline – Users of the customer cannot log on to SAP Business One.
Description – A description for this customer.
InstallationNumber – The installation number of the license file assigned
to the customer. This attribute is mandatory.
Syntax
GET https://hostname:port/sld/sld<version>.svc/Resellers(1)/GetCustomersOfReseller
{
"d":{
"results":[
{
"__metadata":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(37)",
"type":"SLDModel.Customer"
},
"Phone":null,
"Status":"Online",
"Location":null,
"Type":"Customer",
"CreationDate":"\/Date(1349995598397)\/",
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 121
"EmployeeCount":0,
"Country":null,
"ID":37,
"InstallationNumber":"WW-SAP0001",
"ContactPerson":null,
"Email":null,
"Description":null,
"Name":"CustomerA",
"Industry":null,
"Reseller":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(37)/Reseller"
}
},
"Group":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(37)/Group"
}
},
"UsersStorage":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(37)/UsersStorage"
}
}
},
{
"__metadata":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(41)",
"type":"SLDModel.Customer"
},
"Phone":null,
"Status":"Online",
"Location":null,
"Type":"Customer",
"CreationDate":"\/Date(1349999296497)\/",
"EmployeeCount":0,
"Country":null,
"ID":41,
"InstallationNumber":"WW-SAP0001",
"ContactPerson":null,
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
122 rights reserved. Reseller API
"Email":null,
"Description":null,
"Name":"CustomerA1",
"Industry":null,
"Reseller":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(41)/Reseller"
}
},
"Group":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(41)/Group"
}
},
"UsersStorage":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(41)/UsersStorage"
}
}
},
{
"__metadata":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(43)",
"type":"SLDModel.Customer"
},
"Phone":null,
"Status":"Online",
"Location":null,
"Type":"Customer",
"CreationDate":"\/Date(1350156461057)\/",
"EmployeeCount":0,
"Country":null,
"ID":43,
"InstallationNumber":"WW-SAP0001",
"ContactPerson":null,
"Email":null,
"Description":null,
"Name":"CustomerAA",
"Industry":null,
"Reseller":{
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 123
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(43)/Reseller"
}
},
"Group":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(43)/Group"
}
},
"UsersStorage":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(43)/UsersStorage"
}
}
},
{
"__metadata":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(44)",
"type":"SLDModel.Customer"
},
"Phone":null,
"Status":"Online",
"Location":null,
"Type":"Customer",
"CreationDate":"\/Date(1350241187667)\/",
"EmployeeCount":0,
"Country":null,
"ID":44,
"InstallationNumber":"WW-SAP0001",
"ContactPerson":null,
"Email":null,
"Description":null,
"Name":"Customer15",
"Industry":null,
"Reseller":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(44)/Reseller"
}
},
"Group":{
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
124 rights reserved. Reseller API
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(44)/Group"
}
},
"UsersStorage":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/Customers(44)/UsersStorage"
}
}
}
]
},
"actions":{
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.CreateCustomerAsync":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Customers/CreateCustomerAsync",
"title":"CreateCustomerAsync"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.CreateCustomer":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Customers/CreateCustomer",
"title":"CreateCustomer"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.AddUser":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Customers/AddUser",
"title":"AddUser"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.RemoveUser":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Customers/RemoveUser",
"title":"RemoveUser"
}
],
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 125
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.ChangeInstallationNumber"
:[
{
"target":"http://localhost:9080/sld/sld0100.svc/Customers/ChangeInstallationNumber",
"title":"ChangeInstallationNumber"
}
]
},
"functions":{
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.RetrieveAvailableLicenseF
iles":[
{
"target":"http://localhost:9080/sld/sld0100.svc/Customers/RetrieveAvailableLicenseFile
s",
"title":"RetrieveAvailableLicenseFiles"
}
]
}
}
Retrieves a list of all license files assigned to the reseller in the SLD .
Property Description
Parameters None
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
126 rights reserved. Reseller API
Property Description
Localization – The country or countries in which a customer is licensed
to run SAP Business One.
Version – The SAP Business One major release for which the license file
is valid.
Syntax
GET https://hostname:port/sld/sld<version>.svc/Resellers(1)/GetLicensesOfReseller
{
"d":{
"results":[
{
"__metadata":{
"uri":"http://localhost:9080/sld/sld0100.svc/LicenseFiles(1)",
"type":"SLDModel.LicenseFile"
},
"ID":1,
"InstallationNumber":"WW-SAP0001",
"Localization":"WW",
"ExpirationDate":"\/Date(1378252800000)\/",
"SystemNumber":"000000000311809639",
"FileName":"WW-SAP0001",
"Version":"8.8",
"LicenseServer":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/LicenseFiles(1)/LicenseServer"
}
}
},
{
"__metadata":{
"uri":"http://localhost:9080/sld/sld0100.svc/LicenseFiles(24)",
"type":"SLDModel.LicenseFile"
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 127
},
"ID":24,
"InstallationNumber":"SAP-INTERN",
"Localization":"WW",
"ExpirationDate":"\/Date(1381276800000)\/",
"SystemNumber":"000000000311829343",
"FileName":"SAP-INTERN",
"Version":"8.8",
"LicenseServer":{
"__deferred":{
"uri":"http://localhost:9080/sld/sld0100.svc/LicenseFiles(24)/LicenseServer"
}
}
}
]
},
"actions":{
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.ParseLicenseFile":[
{
"target":"http://localhost:9080/sld/sld0100.svc/LicenseFiles/ParseLicenseFile",
"title":"ParseLicenseFile"
}
]
},
"functions":{
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.GetLicenseModules":[
{
"target":"http://localhost:9080/sld/sld0100.svc/LicenseFiles/GetLicenseModules",
"title":"GetLicenseModules"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.GetLicenseModulesBySBOUse
r":[
{
"target":"http://localhost:9080/sld/sld0100.svc/LicenseFiles/GetLicenseModulesBySBOUse
r",
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
128 rights reserved. Reseller API
"title":"GetLicenseModulesBySBOUser"
}
],
"http://localhost:9080/sld/sld0100.svc/$metadata#SLDEntities.GetLicenseAssignments":[
{
"target":"http://localhost:9080/sld/sld0100.svc/LicenseFiles/GetLicenseAssignments",
"title":"GetLicenseAssignments"
}
]
}
}
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Reseller API rights reserved. 129
11 Error Codes
In certain situations, the SLD may return one or more errors in response to a request, with the following syntax:
{
“error”: {
“code”: “500”,
“message”: {
“lang”: “en-US”,
“value”: “Entity not found”
},
“innererror”: {
“message”: “class not found with key 1”,
“type”: “Exception type”,
“stacktrace”: “Error trace”}
}
}
The following table lists the possible error codes returned by the SLD service:
305 {attribute} is invalid; specify a value less than or equal to {Max length}
characters
1002 Error while importing license file; select a valid license file
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
130 rights reserved. Error Codes
Error Code Error Message
3112 You cannot create tenant; specify SAP Business One shared folder
3121 The Customer with “Customer” type cannot have a trial request
3123 The trial request id “{request ID}” of Customer with “Prospect” type is invalid
3125 The Customer with “Prospect” type can have up to two users
3126 The Customer with “Prospect” type can only with install number as “-1”
3127 The Tenant of Customer with “Prospect” type can only be “Trial” purpose
3128 The Tenant with “Trial” purpose cannot have license file
3131 The status of trial request id “{request ID}” of Customer with “Prospect” type is
invalid
3132 The Tenant not with “Trial” purpose cannot be on “Trial” service unit
3135 Error while creating trial tenant on service unit; service unit version should be
8.82 PL07 or later
3138 The Tenant with “Trial” type can have up to two users
3139 The Customer with “Prospect” type can only have one tenant
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Error Codes rights reserved. 131
Error Code Error Message
4103 You cannot continue; user “{account}” does not exist in tenant “{a tenant}”
4104 Deletion is not permitted; user "{user name}" assigned to existing tenants
4105 You cannot continue; installation number is invalid for customer “{customer
name}”
4107 The Business One user code length can’t greater than 8
4204 Invalid parameter, the user id and user system name are not match
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
132 rights reserved. Error Codes
Error Code Error Message
12303 Presentation server with type "{presentation server type}" is not available
PUBLIC
SAP Business One Cloud System Landscape Directory Service API © 2016 SAP SE or an SAP affiliate company. All
Error Codes rights reserved. 133
Error Code Error Message
PUBLIC
© 2016 SAP SE or an SAP affiliate company. All SAP Business One Cloud System Landscape Directory Service API
134 rights reserved. Error Codes
Copyrights, Trademarks, and
Disclaimers