| \n\n**[Map the input variables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/orchestration/CreateInputVariables.md)**\n\n | \n\nUse the variables you created to configure the command that Orchestration executes.\n\n |
| \n\n**REST message**\n\n | \n\nName of an existing REST message to use in this activity.\n\n |
| \n\n**REST message function**\n\n | \n\nREST message function to use for this activity.\n\n |
| \n\n**Endpoint**\n\n | \n\nEndpoint URL for the REST web service this activity uses. Enter an endpoint in this field to override the endpoint configured in the REST message. Click the lock to open the input field.\n\n |
| \n\n**Variable substitutions**\n\n | \n\nName-value pairs to pass to the REST endpoint. You can create these parameters manually, or drag input variables into the parameter fields, and then assign a value. Parameters defined in the REST message that use **$\\{\\}** can be assigned data from this activity template. Use the **Additional attribute** column to configure the system to not escape the text. By default the text sent to the REST message is escaped. If the users have provided variables using [Variable substitution in outbound REST messages](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/web-services/c_VariableSubstitutionREST.md) in the REST message, then the **Name** column is automatically populated.\n\n |
| \n\n**Additional Headers**\n\n | \n\nAdditional HTTP header parameters for the REST message selected. You can also use these values to override parameters inherited from the REST message.\n\n |
| \n\n**Additional Query Parameters**\n\n | \n\nAdditional query parameters for the REST message selected. You can also use these values to override parameters inherited from the REST message.\n\n |
| \n\n**Use MID Server**\n\n | \n\nCheck box that determines if a MID Server should be used to invoke the REST web service.**Note:** If the REST web service message function defines a MID Server, that MID Server is used instead of the one selected here.\n\n |
| \n\n**Required MID Server capabilities**\n\n | \n\nMID Server with the appropriate [MID Server capabilities](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown) for connecting to the REST endpoint. By default, the system selects a MID Server with REST capabilities. This field is available when the **Use MID Server** check box is selected.\n\n |
| \n\n**Timeout**\n\n | \n\nAllowed duration of the REST web service request before it times out, in seconds. The default is **10**.\n\n |
| \n\n**Authentication**\n\n | \n\nDetermines what type of authentication is required for the endpoint. The options are:- **Use existing credentials in REST message**: Uses credential definitions from the REST message definition.\n- **Override with Basic Authentication credentials**: Uses [Enable basic authentication for outbound SOAP](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/web-services/t_BasicAuthentication.md) credentials to override the credentials in the REST message definition. Basic authentication credentials must be provisioned before they are available for selection.\n- **Override with Certificate Authentication credentials**: Uses a certificate, such as a private key, to override the credentials in the REST message definition.\n- **Override with Both Basic and Certificate Authentication credentials**: Uses both basic authentication and certificate authentication to override the credentials in the REST message definition.\n- **Override with OAuth Authentication credentials**: Uses [OAuth 2.0](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/c_OAuthApplications.md) credentials to override the credentials in the REST message definition. The REST message selected for this activity must have its [OAuth 2.0 tutorial - create a REST message](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/web-services/t_OAuthDemoCreateRESTMessage.md) set to **OAuth 2.0** and its [OAuth profiles and scopes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/web-services/c_OAuthProviderAndScope.md) configured appropriately.\n\n\n |
| \n\n**Credentials**\n\n | \n\nRequired REST endpoint basic authentication credentials. This field is available when **Override with Basic Authentication credentials** is selected in the **Authentication** field. Only basic authentication credentials appear in the selection list, which includes credentials stored on the instance and credential IDs from an external storage system. If you are using credentials stored in a CyberArk safe, you can override the default safe defined in the MID Server configuration file. See [Configure the MID Server for CyberArk](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/c_CyberArkIntegrationConfiguration.md) for details. Add the name of a different safe as a prefix to the credential ID, separated by a colon. For example, **newsafe:orch-test-f5**.\n\n |
| \n\n**Protocol Profile**\n\n | \n\nCertificate authentication to use. This field is available when the selections in the **Authentication** are either **Override with Certificate Authentication credentials** or **Override with Both Basic and Certificate Authentication credentials**.\n\n |
| \n\n**OAuth profile**\n\n | \n\nProfile for the OAuth provider for this REST message. See [Specify an OAuth profile](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/web-services/t_SpecifyAnOAuthProfile.md) for more information.\n\n |
| \n\nName\n\n | \n\nVariable\n\n | \n\nType\n\n | \n\nUsage\n\n |
|---|---|---|---|
| \n\nWeb service message\n\n | \n\nweb\\_service\\_message\n\n | \n\nReference\n\n | \n\nThe sys\\_id of the corresponding web service message.\n\n |
| \n\nWeb service message function\n\n | \n\nweb\\_service\\_message\\_function\n\n | \n\nReference\n\n | \n\nThe sys\\_id of the REST message function.\n\n |
| \n\nWeb service endpoint\n\n | \n\nweb\\_service\\_endpoint\n\n | \n\nString\n\n | \n\nURL of the REST endpoint.\n\n |
| \n\nParameters\n\n | \n\nparameters\n\n | \n\nArray of JavaScript objects\n\n | \n\nArray of JavaScript objects, expressed with the `executionParam.` prefix. For instructions on creating arrays using this parameter see [Create a JavaScript array in a REST template](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/orchestration/t_CreateARESTWebServiceActivity.md).\n\n |
| \n\nUse mid server\n\n | \n\nuse\\_mid\\_server\n\n | \n\nBoolean\n\n | \n\nSelects whether or not to use the MID Server. A value of **true** uses the MID Server, and a value of **false** does not use the MID Server.\n\n |
| \n\nMidCapabilities\n\n | \n\nmidCapabilities\n\n | \n\nString \\(comma separated\\)\n\n | \n\nList of references to required MID Server capabilities.\n\n |
| \n\nTime out\n\n | \n\ntime-out\n\n | \n\nString\n\n | \n\nAllowable time out duration, expressed in seconds.\n\n |
| \n\nValueCapabilities\n\n | \n\nvalueCapabilities\n\n | \n\nArray of hashmap\n\n | \n\nCapability values used to select the MID Server. For more information, see [MID Server capabilities](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown). Use this example to customize the MID Server selection if there are additional capabilities that are assigned by value:```\nvar valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'}; executionParam.valueCapabilities.push(valueCapability);\n```\n\n |
| \n\nAuth Type\n\n | \n\nauth-type\n\n | \n\nBoolean\n\n | \n\nType of credentials to use. The choices are:- basic\\_auth\\_pick\\_credentials\n- use\\_existing\\_credentials\n\n |
| \n\nCredentials\n\n | \n\ncredentials\n\n | \n\nReference\n\n | \n\nContains the credentials to use for this REST message when the **auth\\_type** selected is **basic\\_auth\\_pick\\_credentials**.\n\n |
| \n\nField\n\n | \n\nDescription\n\n |
|---|---|
| \n\nInput\n\n | \n\nInput variable builder. [Create input variables](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/servicenow-platform/orchestration/CreateInputVariables.md) to map to available fields.\n\n |
| \n\nREST message\n\n | \n\nName of an existing REST message to use in this activity. Users must have the web\\_service\\_admin role to configure this field.\n\n |
| \n\nREST message function\n\n | \n\nREST message function to use for this activity. Users must have the web\\_service\\_admin role to configure this field.\n\n |
| \n\nEndpoint\n\n | \n\nEndpoint URL for the REST web service this activity uses. Enter an endpoint in this field to override the endpoint configured in the REST message. Click the lock to open the input field.\n\n |
| \n\nVariable substitutions\n\n | \n\nName-value pairs to pass to the REST endpoint. You can create these parameters manually, or drag and drop input variables into the parameter fields, and then assign a value. Parameters defined in the REST message that use **$\\{\\}** can be assigned data from this activity template. Use the **Additional attribute** column to configure the system to not escape the text. By default the text sent to the REST message is escaped. The **Name** column is automatically populated if the users have provided variables using [Variable substitution in outbound REST messages](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/web-services/c_VariableSubstitutionREST.md) in the REST message.\n\n |
| \n\nAdditional Headers\n\n | \n\nAdditional HTTP header parameters for the REST message selected. You can also use these values to override parameters inherited from the REST message.\n\n |
| \n\nAdditional Query Parameters\n\n | \n\nAdditional query parameters for the REST message selected. You can also use these values to override parameters inherited from the REST message.\n\n |
| \n\nUse MID Server\n\n | \n\nCheck box that determines if a MID Server should be used to invoke the REST web service.**Note:** If the REST web service message function defines a MID Server, that MID Server is used instead of the one selected here.\n\n |
| \n\nRequired MID Server capabilities\n\n | \n\nMID Server with the appropriate [MID Server capabilities](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown) for connecting to the REST endpoint. By default, the system selects a MID Server with REST capabilities. This field is available when the **Use MID Server** check box is selected.\n\n |
| \n\nTimeout\n\n | \n\nAllowed duration of the REST web service request before it times out, in seconds. The default is **10**.\n\n |
| \n\nAuthentication\n\n | \n\nDetermines what type of authentication is required for the endpoint. The options are:- **Use existing credentials in REST message**: Uses credential definitions from the REST message definition.\n- **Override with Basic Authentication credentials**: Uses [Enable basic authentication for outbound SOAP](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/web-services/t_BasicAuthentication.md) credentials to override the credentials in the REST message definition. Basic authentication credentials must be provisioned before they are available for selection.\n- **Override with Certificate Authentication credentials**: Uses a certificate, such as a private key, to override the credentials in the REST message definition.\n- **Override with Both Basic and Certificate Authentication credentials**: Uses both basic authentication and certificate authentication to override the credentials in the REST message definition.\n- **Override with OAuth Authentication credentials**: Uses [OAuth 2.0](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/c_OAuthApplications.md) credentials to override the credentials in the REST message definition. The REST message selected for this activity must have its [OAuth 2.0 tutorial - create a REST message](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/web-services/t_OAuthDemoCreateRESTMessage.md) set to **OAuth 2.0** and its [OAuth profiles and scopes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/web-services/c_OAuthProviderAndScope.md) configured appropriately.\n\n\n |
| \n\nCredentials\n\n | \n\nRequired REST endpoint basic authentication credentials. This field is available when **Override with Basic Authentication credentials** is selected in the **Authentication** field. Only basic authentication credentials appear in the selection list, which includes credentials stored on the instance and credential IDs from an external storage system. If you are using credentials stored in a CyberArk safe, you can override the [Configure the MID Server for CyberArk](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/platform-security/t_ConfigureTheMIDServerForCyberArk.md) defined in the MID Server configuration file by adding the name of a different safe as a prefix to the credential ID, separated by a colon. For example, **newsafe:orch-test-f5**.\n\n |
| \n\nProtocol Profile\n\n | \n\nCertificate authentication to use. This field is available when the selections in the **Authentication** field is either **Override with Certificate Authentication credentials** or **Override with Both Basic and Certificate Authentication credentials**.\n\n |
| \n\nOAuth profile\n\n | \n\nProfile for the OAuth provider for this REST message. See [Specify an OAuth profile](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/api-reference/web-services/t_SpecifyAnOAuthProfile.md) for more information.\n\n |