ExternalService

Representation of External Service.

Overview

description string filterable   orderable  
direction enum (INGRESS) filterable   orderable  
entityScope enum (ENTERPRISE | GLOBAL) autogenerated   filterable   orderable  
externalID string filterable   orderable   locally unique  
lastUpdatedBy string autogenerated  
name string required   filterable   orderable  
serviceType enum (L2 | L3) required   filterable   orderable  
stage enum (START) filterable   orderable  

API Resource

/externalservices/id
delete get put

Parents

/enterprises/id/externalservices
get
/enterpriseprofiles/id/externalservices
get put
/externalservices
get post

Children

/externalservices/id/metadatas
get post
/externalservices/id/metadatatags
get
/externalservices/id/globalmetadatas
get post put
/externalservices/id/endpoints
get
/externalservices/id/eventlogs
get

Members

This object has no members.

Attributes documentation

description string filterable   orderable  
Discussion

Description of the External Service.

Charateristics

Format: free
Max length: 255
SDK attribute: description

direction enum filterable   orderable  
Discussion

Direction

Charateristics

Allowed values: INGRESS
SDK attribute: direction

entityScope enum autogenerated   filterable   orderable  
Discussion

Specify if scope of entity is Data center or Enterprise level

Charateristics

Allowed values: ENTERPRISE, GLOBAL
Format: free
SDK attribute: entityScope

externalID string filterable   orderable   locally unique  
Discussion

External object ID. Used for integration with third party systems

Charateristics

Format: free
SDK attribute: externalID

lastUpdatedBy string autogenerated  
Discussion

ID of the user who last updated the object.

Charateristics

Format: free
SDK attribute: lastUpdatedBy

name string required   filterable   orderable  
Discussion

unique name of the External Service.

Charateristics

Format: free
Min length: 1
Max length: 255
SDK attribute: name

serviceType enum required   filterable   orderable  
Discussion

Type of the service.

Charateristics

Allowed values: L2, L3
SDK attribute: serviceType

stage enum filterable   orderable  
Discussion

Stage - START,END Possible values are START, .

Charateristics

Allowed values: START
Format: free
SDK attribute: stage