Show TOC

Object documentationOData Service for Incident Creation

 

You can use the AI_CRM_GW_CREATE_INCIDENT OData service to create incidents from any client application that is able to access this service via the SAP Gateway.

The AI_CRM_GW_CREATE_INCIDENT OData service is stored in the AI_CRM_GW package, in the AI_CRM_GW_CREATE_INCIDENT project.

Structure

The AI_CRM_GW_CREATE_INCIDENT OData service is defined as follows:

Entity Types
Incident

Use Incident to create incidents using the POST OData request on the IncidentSet entity set.

Use the following properties to pass values for incident creation:

  • ProcessType: Process type of the incident

  • Description: Short text of the incident

  • CategoryId: Category ID for the incident (optional). If you provide this property, you must also provide CategoryAspectId and CategoryCatalogType.

  • CategoryAspectId: Aspect ID related to the category (optional)

  • CategoryCatalogType: Catalog type related to the category (optional)

  • SAPComponent: SAP component for which the incident is created (optional)

  • LongText: Long text that describes the incident

  • Priority: Priority of the incident

  • ConfigurationItemId: If the incident reports an issue for a given configuration item (for example, a system), the configuration item can be linked to the incident (optional).

  • Partner1: Business partner 1 of incident

  • PartnerFct1: Business function of partner 1. If it is not provided, business partner 1 is of Reporter business partner function.

  • Partner2: Business partner 2 of incident

  • PartnerFct2: Business function of partner 2. If it is not provided, business partner 2 is of Contact Person business partner function.

  • Partner3: Business partner 3 of incident

  • PartnerFct3: Business function of partner 3. If it is not provided, business partner 3 is of Processor business partner function.

The following properties provide data in return after incident creation:

  • Guid

  • ObjectId

Value Helps

All other entities provide value help for incident creation.

You request the data using GET calls. The value helps are implemented via using the GetEntitySet service of the entity sets.

Entity

Description

BusinessPartner

Returns business partner entities if you pass Name as a filter select option with the “contain pattern” operator.

Use to implement a suggestion input.

The result contains the following:

  • Business partner ID in the Partner field

  • Business partner ID + first name + last name concatenation in the Name field

Category

Returns category entities if you pass the ProcessType as a filter select option with the “equals” operator. You can also pass the CategoryCatalogType as a filter select option with the “equals” operator. If you do not provide the CategoryCatalogType as a filter, the default value is D. With the resulting entity list, you can implement a value help in the form of a popover.

The CategoryLevel field provides the hierarchical level of the given category.

The ListType field shows whether lower level (child) categories are available:

  • Available: ListType value is Navigation

  • Not available: ListType value is Inactive

If you provide the CategoryId filter select option with the “equals” operator, you get all child categories of a CategoryId. If you do not provide the CategoryId filter select option, you get the first level of the category hierarchy (CategoryLevel = 1).

Component

If you provide the CompID filter select option with the “equals” operator or with the “contains pattern” operator, you get all the child components of a CompID. If you do not provide the CompID filter select option, you get the first level of the SAP component hierarchy (CompLevel = 1).

The CompListType field shows whether lower level (child) categories are available:

  • Available: CompListType value is Navigation

  • Not available: CompListType value is Inactive

The CompSelectable field returns X if the SAP component can be selected for an incident.

Configuration Item

Returns configuration item entities by using a “contains pattern” search on the Description filter select option. It searches in all configuration item fields with *search_value*.

The result contains, among others, the following properties with specific scopes:

  • Specific to system: ExtendedSid, InstallationNumber, SystemNumber, SystemType

  • Specific to ABAP system: Client

  • Specific to host: HostName

  • Specific to CMDB: SerialNumber, Manufacturer, Location

Priority

Returns a list of possible priorities as code and description value pair.

No filters are implemented.

Process Type

Used to return a list of all possible process types for which incidents can be created.

Returns the process type code, the language and a short and long description.

No filters are implemented.

Integration

You use SAP Gateway Service Builder (SEGW) on SAP Gateway to display services.