Join the #BuildWithBuildAgent Challenge! Get recognized, earn exclusive swag, and inspire the ServiceNow Community with what you can build using Build Agent.  Join the Challenge.

Global API vs. Scoped API

djuncos
Giga Contributor

I'm not clear on the difference between global API's and scoped API's. I think I may still be struggling with the concept of scope in general.

Does anyone have a clear, concise, general explanation?

Thanks.

6 REPLIES 6

Shakeel Shaik
Giga Sage
Giga Sage

ServiceNow APIs

There are six API categories:

  • Client: Client-side API for desktop apps
  • Client Mobile: ServiceNow Classic mobile application API. Not for ServiceNow Agent, Now Mobile, or ServiceNow Onboarding
  • Now Experience UI Framework: Agent Workspace component API
  • Server Scoped: Scoped application API for server-side
  • Server Global: Global application API for server-side
  • REST: Restful APIs for interacting with a ServiceNow instance

Visit the ServiceNow Developer Site to find the complete API reference. Click the Reference menu then select an API. The API reference documents the classes, methods, and non-method properties comprising the API.

 

Use the Reference menu to access the API documentation by API type:  REST, Server Scoped, Server Global, Now Experience UI Framework, Client, Client Mobile.

 

For most methods the API reference documents include:

  • Method name
  • Method description
  • Return data type
  • Return data description
  • Example script
    Example API documentation for the GlideUser class, getFullName() method.

Refer to the API documentation early and often when building apps on the Now platform.

Selecting the API Release

All API content is versioned. When viewing API documentation, use the release selector to choose a release. The release selector is above the API class name.

 

The release selector has a choice for each available release of ServiceNow API documentation.

 

Scoped Vs. Global

Applications developed in custom scopes do not use the same server-side APIs as applications built in the Global scope. When viewing server-side API documentation, use the Reference menu to select the correct scope.

 

Select the scoped tab in the left-hand navigation pane  Scoped (custom) or Legacy (global).

 

If API documentation is already open, use the API Type field to change the API reference.

 

The API Type field is in the API reference navigator (left pane).
 
Thanks,
Shakeel Shaik 🙂

newhand
Mega Sage

hello @Shakeel Shaik 

Would you please tell me why API for server-side has two types as below .

I can not understand the purpose ...

  • Server Scoped: Scoped application API for server-side
  • Server Global: Global application API for server-side

 

Please mark my answer as correct and helpful based on Impact.