PUT v1/ExternalApis

User roles allowed to make this request: DomainAdministrator PowerUser GlobalDomainManager

Permissions required to make this request: ExternalApi.Write ExternalApi.Read

Update existing external api configuration

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
Name	The name used to reference the external api	string	Required Max length: 16
Description	The description of the api	string	Max length: 4096
Uri	The endpoint of the api	string	Required Max length: 1024
HelpUri	Address for help about the api	string	Max length: 1024
Headers	The headers for the api	Collection of ExternalApiHeaderModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "Uri": "sample string 3",
  "HelpUri": "sample string 4",
  "Headers": [
    {
      "HeaderId": 1,
      "Name": "sample string 2",
      "Value": "sample string 3",
      "IsObfuscated": true
    },
    {
      "HeaderId": 1,
      "Name": "sample string 2",
      "Value": "sample string 3",
      "IsObfuscated": true
    }
  ]
}

application/xml, text/xml

Sample:

<ExternalApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <Description>sample string 2</Description>
  <Headers>
    <ExternalApiHeaderModel>
      <HeaderId>1</HeaderId>
      <IsObfuscated>true</IsObfuscated>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
    </ExternalApiHeaderModel>
    <ExternalApiHeaderModel>
      <HeaderId>1</HeaderId>
      <IsObfuscated>true</IsObfuscated>
      <Name>sample string 2</Name>
      <Value>sample string 3</Value>
    </ExternalApiHeaderModel>
  </Headers>
  <HelpUri>sample string 4</HelpUri>
  <Name>sample string 1</Name>
  <Uri>sample string 3</Uri>
</ExternalApiModel>

application/x-www-form-urlencoded

Sample:

Name=sample&Description=sample&Uri=sample&HelpUri=sample&Headers=IEnumerable`1

multipart/form-data

Sample:

Sample not available.

Response Information

Resource Description

Response Message

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.