Contents Now Platform Custom Business Applications Previous Topic Next Topic Create a Scripted REST API ... SAVE AS PDF Selected Topic Topic & Subtopics All Topics in Contents Other Share Create a Scripted REST API Create a Scripted REST API to define web service endpoints. Before you beginRole required: web_service_admin Procedure Navigate to System Web Services > Scripted REST APIs. Click New. Enter a Name for the service. The API ID is set automatically based on the Name. You can modify the API ID if needed. Click Submit. What to do nextAfter you create the API, configure the service as needed such as by creating resources, assigning ACLs, or specifying supported request and response formats. Create a scripted REST API resourceCreate a scripted REST API resource to define the HTTP method, the processing script, and to override settings from the parent service.Define scripted REST API headersDefine scripted REST API headers to control which headers the API accepts and can respond with.Define available query parametersDefine available query parameters to control what values a requesting user can pass in the request URI.Configure a scripted REST API to require an ACLConfigure a scripted REST API to require that requesting users satisfy an ACL.Enable versioning for a scripted REST APIEnable versioning for a scripted REST API to provide multiple versions of the API while maintaining compatibility with existing integrations.Controlling request and response content typeYou can control which content types are allowed in scripted REST API requests and responses.Controlling maximum request sizeYou can specify the maximum file size allowed in a scripted REST API request payload. On this page Send Feedback Previous Topic Next Topic
Create a Scripted REST API Create a Scripted REST API to define web service endpoints. Before you beginRole required: web_service_admin Procedure Navigate to System Web Services > Scripted REST APIs. Click New. Enter a Name for the service. The API ID is set automatically based on the Name. You can modify the API ID if needed. Click Submit. What to do nextAfter you create the API, configure the service as needed such as by creating resources, assigning ACLs, or specifying supported request and response formats. Create a scripted REST API resourceCreate a scripted REST API resource to define the HTTP method, the processing script, and to override settings from the parent service.Define scripted REST API headersDefine scripted REST API headers to control which headers the API accepts and can respond with.Define available query parametersDefine available query parameters to control what values a requesting user can pass in the request URI.Configure a scripted REST API to require an ACLConfigure a scripted REST API to require that requesting users satisfy an ACL.Enable versioning for a scripted REST APIEnable versioning for a scripted REST API to provide multiple versions of the API while maintaining compatibility with existing integrations.Controlling request and response content typeYou can control which content types are allowed in scripted REST API requests and responses.Controlling maximum request sizeYou can specify the maximum file size allowed in a scripted REST API request payload.
Create a Scripted REST API Create a Scripted REST API to define web service endpoints. Before you beginRole required: web_service_admin Procedure Navigate to System Web Services > Scripted REST APIs. Click New. Enter a Name for the service. The API ID is set automatically based on the Name. You can modify the API ID if needed. Click Submit. What to do nextAfter you create the API, configure the service as needed such as by creating resources, assigning ACLs, or specifying supported request and response formats. Create a scripted REST API resourceCreate a scripted REST API resource to define the HTTP method, the processing script, and to override settings from the parent service.Define scripted REST API headersDefine scripted REST API headers to control which headers the API accepts and can respond with.Define available query parametersDefine available query parameters to control what values a requesting user can pass in the request URI.Configure a scripted REST API to require an ACLConfigure a scripted REST API to require that requesting users satisfy an ACL.Enable versioning for a scripted REST APIEnable versioning for a scripted REST API to provide multiple versions of the API while maintaining compatibility with existing integrations.Controlling request and response content typeYou can control which content types are allowed in scripted REST API requests and responses.Controlling maximum request sizeYou can specify the maximum file size allowed in a scripted REST API request payload.
