1. APIs
  2. Service Catalog

Contents

Summary

Contains methods for working with the service catalog.

Application Identifier Use

This set of APIs uses a application identifier parameter, named appId and of type Int32, which specifies the corresponding application in which actions should be performed.

For the sake of brevity, it is omitted from the parameter list of the API methods below, but still needs to be included whenever there is an {appId} placeholder in the URL for the API method.

API Methods

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/services Copy URL

Gets all services that are visible to the user.

Returns

A list of all services that are visible to the user. (TeamDynamix.Api.ServiceCatalog.Service[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

This endpoint will not return all service information. For example, the following properties will not be included in the results:
  • ServiceOfferings
  • Attachments
  • Attributes
  • LongDescription
To retrieve such information, you must load a service individually.

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/services Copy URL

Creates a Service Catalog service. This operation requires the permission to add services.

Parameters

Returns

The created service if the operation was successful.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

It is not possible to change the public status or other permissions for the service through this method. The permissions will be automatically inherited from the parent category (or, in the case of a root-level service, will be defaulted to public).

DELETE https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{id} Copy URL

Deletes a Service Catalog service.

Parameters

Returns

A response message indicating if the operation was successful or not.

Access Restrictions

This action can only be performed by application administrators.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

Deletions are only allowed if the service has no associated items. Items that can be associated are:
  • Service Offerings
  • Projects
  • Project Requests
  • Tickets
  • Email Monitors
  • Survey Responses

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{id} Copy URL

Gets a service.

Parameters

Returns

The service if it was found. (TeamDynamix.Api.ServiceCatalog.Service)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

PUT https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{id} Copy URL

Edits an existing Service Catalog service. This operation requires the permission to manage the specified service.

Parameters

Returns

The updated service. (TeamDynamix.Api.ServiceCatalog.Service)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

This will not update the service's permission options (such as that of permission inheritance, public status, or allowlist/denylist options). Active status, however, can still be modified through this method.

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{id}/attachments?showViewLink={showViewLink} Copy URL

Adds an attachment to a service. This operation requires the permission to manage the specified service.

Parameters

File Upload

This action accepts an uploaded file as part of the form's submission. For information on how to structure calls with files, see the Submitting Files page.

Returns

The created attachment, if the operation was successful.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{id}/permissions Copy URL

Gets the permissions set on the specified service. This operation requires the ability to manage the specified service.

Parameters

Returns

The permissions for the specified service, if the operation was successful. (TeamDynamix.Api.Permissions.PermissionStore)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

PUT https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{id}/permissions Copy URL

Edits the permissions set on the specified service. This operation requires the ability to manage the specified service.

Parameters

Returns

The updated permissions for the specified service, if the operation was successful. (TeamDynamix.Api.Permissions.PermissionStore)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{id}/relatedarticles Copy URL

Gets a list of the knowledge base articles associated with the specified service that the user has permission to see.

Parameters

Returns

The associated knowledge base articles that the user has permission to see. (TeamDynamix.Api.KnowledgeBase.Article[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

DELETE https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{id}/relatedarticles/{relatedArticleId} Copy URL

Removes a relationship between the service and the specified Knowledge Base article.

Parameters

Returns

A response message indicating if the operation was successful or not.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

This action requires that the user have access to the specified Client Portal application, the permission to view the Service Catalog, and either the ability to manage the service or to edit the related article.

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{id}/relatedarticles/{relatedArticleId} Copy URL

Adds a relationship between the service and the specified Knowledge Base article.

Parameters

Returns

A response message indicating if the operation was successful or not.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

This action requires that the user have access to the specified Client Portal application, the permission to view the Service Catalog, and one of the following permission combinations:
  • The permission to manage the service and the access to view the article
  • The permission to edit the article and the access to view the service

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{serviceId}/offerings Copy URL

Creates a service offering for the specified parent service. This operation requires the permission to manage the parent service, as well as the permission to modify service offerings.

Parameters

Returns

The created service offering if the operation was successful.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

DELETE https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{serviceId}/offerings/{id} Copy URL

Deletes a Service Catalog service offering.

Parameters

Returns

A response message indicating if the operation was successful or not.

Access Restrictions

This action can only be performed by application administrators.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

Deletions are only allowed if the service offering has no associated items. Items that can be associated are:
  • Projects
  • Project Requests
  • Tickets
  • Email Monitors
  • Survey Responses

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{serviceId}/offerings/{id} Copy URL

Gets a service offering.

Parameters

Returns

The service offering if it was found. (TeamDynamix.Api.ServiceCatalog.ServiceOffering)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

PUT https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{serviceId}/offerings/{id} Copy URL

Edits an existing service offering for the specified parent service. This operation requires the permission to manage the parent service, as well as the permission to modify service offerings.

Parameters

Returns

The updated service offering. (TeamDynamix.Api.ServiceCatalog.ServiceOffering)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{serviceId}/offerings/{id}/attachments?showViewLink={showViewLink} Copy URL

Adds an attachment to a service offering. This operation requires the permission to manage the parent service, as well as the permission to modify service offerings.

Parameters

File Upload

This action accepts an uploaded file as part of the form's submission. For information on how to structure calls with files, see the Submitting Files page.

Returns

The created attachment, if the operation was successful.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{serviceId}/offerings/{id}/relatedarticles Copy URL

Gets a list of the knowledge base articles associated with the specified service offering that the user has permission to see.

Parameters

Returns

The associated knowledge base articles that the user has permission to see. (TeamDynamix.Api.KnowledgeBase.Article[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

DELETE https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{serviceId}/offerings/{id}/relatedarticles/{relatedArticleId} Copy URL

Removes a relationship between the service offering and the specified Knowledge Base article.

Parameters

Returns

A response message indicating if the operation was successful or not.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

This action requires that the user have access to the specified Client Portal application, the permission to view the Service Catalog, and either the ability to manage the service offering or to edit the related article.

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/services/{serviceId}/offerings/{id}/relatedarticles/{relatedArticleId} Copy URL

Adds a relationship between the service offering and the specified Knowledge Base article.

Parameters

Returns

A response message indicating if the operation was successful or not.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

This action requires that the user have access to the specified Client Portal application, the permission to view the Service Catalog, and one of the following permission combinations:
  • The permission to manage the service offering and the access to view the article
  • The permission to edit the article and the access to view the service offering

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/services/categories Copy URL

Creates a service catalog category. This operation requires the permission to modify service categories.

Parameters

Returns

The created category, if the operation was successful.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

It is not possible to change the public status or other permissions for the category through this method. The permissions will be automatically inherited from the parent category (or, in the case of a root-level category, will be defaulted to public).

DELETE https://services.dartmouth.edu/TDWebApi/api/{appId}/services/categories/{id} Copy URL

Deletes the specified category. This operation requires the permission to modify service categories.

Parameters

Returns

A response message indicating if the operation was successful or not.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

Deletions are only allowed if the category has no child categories or child services.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/services/categories/{id} Copy URL

Gets the specified category.

Parameters

Returns

The specified category, if the operation was successful. (TeamDynamix.Api.ServiceCatalog.ServiceCategory)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

PUT https://services.dartmouth.edu/TDWebApi/api/{appId}/services/categories/{id} Copy URL

Edits the specified category. This operation requires the permission to modify service categories.

Parameters

Returns

The updated category. (TeamDynamix.Api.ServiceCatalog.ServiceCategory)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

This will not update the category's permission options (such as that of permission inheritance, public status, or allowlist/denylist options).

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/services/categories/{id}/permissions Copy URL

Gets the permissions set on the specified category. This operation requires the permission to modify service categories.

Parameters

Returns

The permissions for the specified category, if the operation was successful. (TeamDynamix.Api.Permissions.PermissionStore)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

PUT https://services.dartmouth.edu/TDWebApi/api/{appId}/services/categories/{id}/permissions Copy URL

Edits the permissions set on the specified category. This operation requires the permission to modify service categories.

Parameters

Returns

The updated permissions for the specified category, if the operation was successful. (TeamDynamix.Api.Permissions.PermissionStore)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/services/categories?isActive={isActive} Copy URL

Gets the categories for the service catalog.

Parameters

Returns

A hierarchical list of service catalog categories. (TeamDynamix.Api.ServiceCatalog.ServiceCategory[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

The value of the isActive parameter will only be respected for users with permission to modify service categories. For users without this permission, the value of isActive will always evaluate to true.

GET https://services.dartmouth.edu/TDWebApi/api/{appId}/services/icons Copy URL

Gets the valid Font-Awesome icons, and their associated integer codes, to use with service catalog items (such as categories and service offerings).

Returns

A dictionary of Font-Awesome icon names with their associated integer codes. (Dictionary<String, Int32>)

Remarks

The returned dictionary will look similar to the following:
{ "address-book": 62137, "address-book-o": 62138, "address-card": 62139, ... }

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/services/offerings/search Copy URL

Gets a list of Service Catalog service offerings. Will not return full service offering information.

Parameters

Returns

A list of service offerings matching the specified criteria. (TeamDynamix.Api.ServiceCatalog.ServiceOffering[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

Certain searching parameters can only be used by individuals with the "View All Services" permission. For example, searching on the basis of active status can only be performed by these individuals.

This endpoint will not return all service information. For example, the following properties will not be included in the results:
  • Attachments
  • Attributes
To retrieve such information, you must load a service offering individually.

POST https://services.dartmouth.edu/TDWebApi/api/{appId}/services/search Copy URL

Gets a list of Service Catalog services. Will not return full service information.

Parameters

Returns

A list of services matching the specified criteria. (TeamDynamix.Api.ServiceCatalog.Service[])

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

Remarks

Certain searching parameters can only be used by individuals with the "View All Services" permission. For example, searching on the basis of active status can only be performed by these individuals.

This endpoint will not return all service information. For example, the following properties will not be included in the results:
  • Attachments
  • Attributes
To retrieve such information, you must load a service individually.