Important

   

Starting from version 8.9.03, BMC Network Automation is renamed to TrueSight Network Automation. This space contains information about TrueSight Network Automation 8.9.03 and the later service packs for 8.9. For earlier releases, see BMC Network Automation 8.9.

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
 Retrieves email distribution lists, matching any filter criteria
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

[
   #EmailDistributionListDTO
]

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

POST /v3.0/email_distribution_lists
 Adds a new email distribution list
Parameters

Name

Located in

Description

Default

Schema

body

body

Complete attributes of the new email distribution list

#EmailDistributionListDTO

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

GET /v3.0/email_distribution_lists/{nameOrKey}
 Retrieves one email distribution list either by name or by database key
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

#EmailDistributionListDTO

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

PUT /v3.0/email_distribution_lists/{nameOrKey}
 Modifies all attributes of an existing email distribution list
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

#EmailDistributionListDTO

Authorization

header

Authorization token formatted as 'Bearer [token]'

String *

Responses

Code

Description

Schema

200

successful operation

#EmailDistributionListDTO

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

DELETE /v3.0/email_distribution_lists/{nameOrKey}
 Deletes an unreferenced email distribution list
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

PATCH /v3.0/email_distribution_lists/{nameOrKey}
 Modifies only the specified attributes of an existing email distribution list, where the changes are specified in JSON Patch format (per RFC 6902)
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

#JsonPatch

Authorization

header

Authorization token formatted as 'Bearer [token]'

String *

Responses

Code

Description

Schema

200

Successful operation

#EmailDistributionListDTO

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

 A dynamic field value

{
     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

 Information about an email distribution list

{
     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

 A list of JSON Patch operations

[
     A list of JSON Patch operations
 
     #JsonPatch.OneOperation
   ]

JsonPatch.OneOperation

JsonPatch.Pointer

 Pointer or path to an element or property

string
   Pointer or path to an element or property

JsonPatch.Add

 Add a value to an object or inserts it into an array. In the case of an array, the value is inserted before the given index. The - character can be used instead of an index to insert at the end of an array. The value can be any JSON value.

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

JsonPatch.Remove

 Remove a value from an object or array.

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

JsonPatch.Replace

 Replace an existing value. The value can be any JSON value.

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

JsonPatch.Move

 Move a value from one location to the other. "path" is the destination.

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

JsonPatch.Copy

 Copy a value from one location to another. "path" is the destination.

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

JsonPatch.Test

 Test that the specified value is set in the document at the specified path. If the test fails, then the patch as a whole is not applied. The Value can be any JSON value.

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

Was this page helpful? Yes No Submitting... Thank you

Comments