Skip to Content

Email Distribution Lists API

TrueSight Network Automation REST API – Version 3.0 -- Email Distribution Lists
The base URL for the API is:

https://<serverName>:<portNumber>/bca-networks/api

GET

 /v3.0/email_distribution_lists =====

Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

orderBy

query

Sort by the specified attribute (name, addresses, or a listable email distribution list dynamic field name) in the specified order (prefix with a '+' for ascending or a '-' for descending)

"+name"

string 
Enum: [
 "+name",
 "-name",
 "+addresses",
 "-addresses"
]

offset

query

Return the specified page number

1

integer

limit

query

Define the number of rows in a page or the maximum number of email distribution lists to return

25

integer

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

String *

Responses

Code

Description

Schema

200

Successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to access email distribution lists

 

500

Internal server error: Unexpected exception occurred

 

{{status colour="Green" title="POST"/}}

 /v3.0/email_distribution_lists
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new email distribution list

 

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

String *

Responses

Code

Description

Schema

201

Created: New email distribution list successfully added

 

400

Bad request: Input email distribution list DTO is missing or new email distribution list is invalid

 

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to add a new email distribution list

 

500

Internal server error: Unexpected exception occurred

 

{{status colour="Blue" title="GET"/}}

 /v3.0/email_distribution_lists/{nameOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the email distribution list of interest

 

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

String *

Responses

Code

Description

Schema

200

successful operation

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to access email distribution lists

 

404

Not found: No single matching email distribution list found

 

500

Internal server error: Unexpected exception occurred

 

{{status colour="Yellow" title="PUT"/}}

 /v3.0/email_distribution_lists/{nameOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the email distribution list to be modified

 

string *

body

body

Complete new attribute values for the email distribution list; anything left out will be considered to be null and will be nulled out in the email distribution list

 

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

String *

Responses

Code

Description

Schema

200

successful operation

400

Bad request: Input email distribution list DTO is missing or modified email distribution list is invalid

 

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to modify the email distribution list

 

404

Not found: No single matching email distribution list found

 

500

Internal server error: Unexpected exception occurred

 

{{status colour="Red" title="DELETE"/}}

 /v3.0/email_distribution_lists/{nameOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the email distribution list to be deleted

 

string *

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

String *

Responses

Code

Description

Schema

200

Successful operation

string

400

Bad request: Email distribution list is currently in use by a job, predefined job, or policy

 

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to delete the email distribution list

 

404

Not found: No single matching email distribution list found

 

500

Internal server error: Unexpected exception occurred

 

{{status colour="Yellow" title="PATCH"/}}

 /v3.0/email_distribution_lists/{nameOrKey}
Click here to expand...
Parameters

Name

Located in

Description

Default

Schema

nameOrKey

path

Name or database key of the email distribution list to be modified

 

string *

body

body

New attribute values for the email distribution list, in JSON Patch format

 

Authorization

header

Authorization token formatted as 'Bearer [token]'

 

String *

Responses

Code

Description

Schema

200

Successful operation

400

Bad request: Input JSON patch information is missing or modified email distribution list is invalid

 

401

Unauthorized: Failed to provide a suitable Authorization header or the specified user is not logged in

 

403

Forbidden: Not allowed to modify the email distribution list

 

404

Not found: No single matching email distribution list found

 

500

Internal server error: Unexpected exception occurred

 

Object Definitions

Object

Schema

DynamicFieldValueDTO

Click here to expand...

{ 
    id: string 
    The database key of the dynamic field whose value this is (read-only) 

     name: string 
    The name of the dynamic field (read-only) 

     values: [ 
      The value(s) for the dynamic field; for a single-value field, only the first entry is relevant; read-only for Auto Derived and Configuration Profiled types 

       string 
    ] 

     dynamicFieldDetailsLink: string 
    Link to get more detailed information about the dynamic field (read-only) 
}

EmailDistributionListDTO

Click here to expand...

{ 
    id: string 
    The email distribution list's unique database key (read-only) 

     name: string * 
    The email distribution list's unique display name 

     addresses: [ 
      The email addresses that make up this list 

       string 
    ] * 

     dynamicFields: [ 
      The dynamic fields 

       #DynamicFieldValueDTO 
    ] 
}

JsonPatch

Click here to expand...

[ 
    A list of JSON Patch operations 

     #JsonPatch.OneOperation 
  ]

JsonPatch.OneOperation

JsonPatch.Pointer

Click here to expand...

string 
  Pointer or path to an element or property

JsonPatch.Add

Click here to expand...

{ 
    op: string * 
   Enum: [
     "add"
   ]
    value: any * 
    path: #JsonPatch.Pointer *
}

JsonPatch.Remove

Click here to expand...

{ 
    op: string * 
   Enum: [
     "remove"
   ]
    path: #JsonPatch.Pointer *
}

JsonPatch.Replace

Click here to expand...

{ 
    op: string * 
   Enum: [
     "replace"
   ]
    value: any * 
    path: #JsonPatch.Pointer *
}

JsonPatch.Move

Click here to expand...

{ 
    op: string * 
   Enum: [
     "move"
   ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

JsonPatch.Copy

Click here to expand...

{ 
    op: string * 
   Enum: [
     "copy"
   ]
    path: #JsonPatch.Pointer *
    from: #JsonPatch.Pointer *
}

JsonPatch.Test

Click here to expand...

{ 
    op: string * 
   Enum: [
     "test"
   ]
    value: any * 
    path: #JsonPatch.Pointer *
}

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*

TrueSight Network Automation 21.08