A service in the service catalog.
| Name | Editable? | Required? | Type | Nullable? | Summary |
|---|---|---|---|---|---|
| ID | Int32 | The ID of the service. | |||
| AppID | Int32 | The ID of the client portal application associated with the service. | |||
| AppName | String | The name of the client portal application associated with the service. | |||
| Name | This field is editable through the web API. | This field is required. | String | The name of the service. | |
| ShortDescription | This field is editable through the web API. | String | The short description of the service, which is used when displaying the service in a list. | ||
| LongDescription | This field is editable through the web API. | String | The long description of the service, which is used when viewing the specific service. This can contain HTML. | ||
| CategoryID | This field is editable through the web API. | Int32 | The ID of the category associated with the service. | ||
| CategoryName | String | The name of the category associated with the service. | |||
| FullCategoryText | String | The full text of the hierarchy for the category associated with the service. | |||
| CompositeName | String | The composite name of the service, which includes the name of the immediate parent category. | |||
| Order | This field is editable through the web API. | Double | The order of the service among its siblings. | ||
| IsActive | This field is editable through the web API. | Boolean | The active status of the service. | ||
| IsPublic | Boolean | The public status of the service, indicating if it is visible to unauthenticated users. | |||
| CreatedDateUtc | DateTime | Gets or sets the UTC date/time the service was created. | |||
| CreatedUID | Guid | Gets or sets the ID of the user who created the service. | |||
| CreatedFullName | String | This field is nullable. | Gets or sets the full name of the user who created the service. | ||
| ModifiedDateUtc | DateTime | Gets or sets the UTC date/time the service was last modified. | |||
| ModifiedUID | Guid | Gets or sets the ID of the user who last modified the service. | |||
| ModifiedFullName | String | This field is nullable. | Gets or sets the full name of the user who last modified the service. | ||
| ManagerUid | This field is editable through the web API. | Guid | The UID of the managing user associated with the service. This value will be preferred over ManagingGroupID if both are present. | ||
| ManagerFullName | String | The full name of the managing user associated with the service. | |||
| ManagingGroupID | This field is editable through the web API. | Int32 | The ID of the managing group associated with the service. The ManagerUid value will be preferred over this if both are present. | ||
| ManagingGroupName | String | The name of the managing group associated with the service. | |||
| RequestText | This field is editable through the web API. | String | The custom text used for the "Request This" button. | ||
| SubmitText | This field is editable through the web API. | String | The custom text used for the "Submit" button. | ||
| RequestTypeComponent | This field is editable through the web API. | This field is required. | TeamDynamix.Api.ServiceCatalog.RequestComponent |
The component associated with the service's request type.
For service edits, the required status will be ignored if the service has service offerings.
|
|
| RequestUrl | This field is editable through the web API. | String |
The custom request URL of the service.
When this is used, the RequestTypeComponent
should be RequestComponent.Link.
This value will be conditionally required
if the RequestTypeComponent value is
RequestComponent.Link.
|
||
| RequestApplicationID | This field is editable through the web API. | Int32 |
The ID of the destination application for any
requests generated by the service.
This value will be conditionally required, and user access to the application validated,
if the RequestTypeComponent value
is RequestComponent.Ticket.
When editing a ticket service, this value will be disallowed from changing if the current service is set to use a ticketing application the user does not have access to. |
||
| RequestApplicationName | String | The name of the destination application for any requests generated by the service. | |||
| RequestApplicationIsActive | Boolean | The active status of the destination application for any requests generated by the service. | |||
| RequestTypeID | This field is editable through the web API. | Int32 |
The ID of the request type associated with the service.
This value will be conditionally required
if the RequestComponent has a value of
RequestComponent.Project or
RequestComponent.Ticket.
|
||
| RequestTypeName | String | The name of the request type associated with the service. | |||
| RequestTypeIsActive | Boolean | The active status of the request type associated with the service. | |||
| RequestTypeCategoryID | Int32 | The ID of the category associated with the service's request type. | |||
| RequestTypeCategoryName | String | The name of the category associated with the service's request type. | |||
| WorkflowID | This field is editable through the web API. | Int32 |
The ID of the associated workflow used for any (ticketing) requests.
When editing a ticket service, this value will be disallowed from changing if the
current service is set to use a ticketing application the user does not
have access to.
|
||
| WorkflowName | String | This field is nullable. | The name of the associated workflow used for any (ticketing) requests. | ||
| ShouldNotifyResp | This field is editable through the web API. | Boolean | Whether the responsible user should be notified upon ticket creation (for ticketing services). | ||
| ShouldNotifyRequestor | This field is editable through the web API. | Boolean | Whether the requestor should be notified upon upon ticket creation (for ticketing services). | ||
| MaintenanceScheduleID | This field is editable through the web API. | Int32 |
The ID of the maintenance window associated with the service.
This value will not be editable if the user has no access to any active asset/CI application.
This value will also not be editable if the user is editing the service, no change
is being made to the ConfigurationItemAppID value, but the user cannot access
the current asset/CI application represented by the server value for
ConfigurationItemAppID.
|
||
| MaintenanceScheduleName | String | The name of the maintenance window associated with the service. | |||
| ConfigurationItemAppID | This field is editable through the web API. | This field is required. | Int32 |
The asset application ID of the configuration item record associated with the service.
This value is required and is validated against the set of active asset/CI applications
which the user can access.
If the user has access to at least one active asset/CI application, invalid application IDs will result in a 400 Bad Request response. If the user cannot access any active asset/CI application, send a value of 0. However, no matter what value is sent in this situation, the organization's default asset/CI application will be used for creates and the currently saved value on the server will be used for edits. When editing, this value cannot be changed if there are any service relationships or maintenance windows specified. |
|
| ConfigurationItemID | Int32 | The ID of the configuration item record associated with the service. | |||
| ServiceOfferingsCount | Int32 | The number of service offerings that are contained by this service. | |||
| ServiceOfferings | TeamDynamix.Api.ServiceCatalog.ServiceOfferingListing[] | This field is nullable. | The service offerings associated with the service. | ||
| Tags | This field is editable through the web API. | String[] | This field is nullable. | The tags associated with the service. | |
| Attachments | TeamDynamix.Api.Attachments.Attachment[] | This field is nullable. | The attachments associated with the service. | ||
| Attributes | This field is editable through the web API. | TeamDynamix.Api.CustomAttributes.CustomAttribute[] | This field is nullable. | The custom attributes associated with the service. | |
| Uri | String | The URI to retrieve the full details of the service via the web API. |