Skip to main content

business_services

Overview

Namebusiness_services
TypeResource
Idpagerduty.business_services.business_services

Fields

NameDatatypeDescription
idstring
namestringThe name of the business service.
descriptionstringThe user-provided description of the business service.
html_urlstringa URL at which the entity is uniquely displayed in the Web app
point_of_contactstringThe point of contact assigned to this service.
selfstringthe API show URL at which the object is accessible
summarystringA short-form, server-generated string that provides succinct, important information about an object suitable for primary labeling of an entity in a client. In many cases, this will be identical to name, though it is not intended to be an identifier.
teamobjectReference to the team that owns the business service.
typestringA string that determines the schema of the object. This must be the standard name for the entity, suffixed by _reference if the object is a reference.

Methods

NameAccessible byRequired ParamsDescription
get_business_serviceSELECTidGet details about an existing Business Service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the API Concepts Document

Scoped OAuth requires: services.read
list_business_servicesSELECTList existing Business Services.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the API Concepts Document

Scoped OAuth requires: services.read
create_business_serviceINSERTCreate a new Business Service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

There is a limit of 5,000 business services per account. If the limit is reached, the API will respond with an error.

For more information see the API Concepts Document

Scoped OAuth requires: services.write
delete_business_serviceDELETEidDelete an existing Business Service.

Once the service is deleted, it will not be accessible from the web UI and new incidents won't be able to be created for this service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the API Concepts Document

Scoped OAuth requires: services.write
_get_business_serviceEXECidGet details about an existing Business Service.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the API Concepts Document

Scoped OAuth requires: services.read
_list_business_servicesEXECList existing Business Services.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the API Concepts Document

Scoped OAuth requires: services.read
update_business_serviceEXECidUpdate an existing Business Service. NOTE that this endpoint also accepts the PATCH verb.

Business services model capabilities that span multiple technical services and that may be owned by several different teams.

For more information see the API Concepts Document

Scoped OAuth requires: services.write