Create an External Service Catalog

Owned by Enterprise IT
May 29, 2024
4 min read

You can create an SR with an external Service Catalog using the following API Request.

To authenticate the below API, see API Authentication and Authorization.

Service NameHTTP Method
SR_LogServiceCatalogForExternal

POST


Sample Request
{
  "ServiceName": "SR_LogServiceCatalogForExternal",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXXXXXXXXXXXXX",
      "OrgID": "1",
      "ReturnType": "JSON",
      "ProxyID": 0,
      "TokenID": ""
    },
    "objSRServiceTicketCatalogParam": {
      "ServiceCatalogID": 3,
      "LogSRForUserMode": false,
      "ServiceCategoryID": 1,
      "DelegationMode": false,
      "WorkGroupID": 6,
      "DelegateeUserID": 0,
      "Org_ID": 1,
      "ListCustomAttributes": [
        {
          "Attribute_Type": "TextBox",
          "Attribute_Value": "Test Attributes",
          "Attribute_Name": "Test TextBox",
          "Attribute_ID": 3867
        },
        {
          "Attribute_Type": "CheckBox",
          "Attribute_Value": true,
          "Attribute_Name": "Test Checkbox",
          "Attribute_ID": 3868
        }
      ],
      "ServiceCategoryName": "Desktop",
      "ListMVCustomAttributes": [
        {
          "RowID": "1",
          "Attribute_Value": 1,
          "AttributeType": "DROPDOW NLIST",
          "Attribute_ID": "1",
          "Attribute_Name": "Location",
          "Attribute_Text": "Test1"
        },
        {
          "RowID": "1",
          "Attribute_Value": 2,
          "AttributeType": "DROPDOWNLIST",
          "Attribute_ID": "3",
          "Attribute_ Name": "attachment",
          "Attribute_Text": "Test2"
        },
        {
          "RowID": "1",
          "Attribute_Value": "4",
          "Attribute Type": "DROPDOWNLIST",
          "Attribute_ID": "4",
          "Attribute_Name": "Items",
          "Attribute_Text": "T est3"
        }
      ],
      "ServiceCatalogName": "Catalog Name",
      "JustificationRemarks": "Test Remarks..",
      "NoOfApprovals": 2,
      "SupportFunction": "IT Tec",
      "Approver1": "Workgroup Owner Approval",
      "Approver1Id": "9",
      "Approver1Name": "Approver Name",
      "Approver2": "",
      "Approver2Id": "",
      "Approver2Name": ""
    }
  }
}

Request Parameters

Parameter NameTypeDescriptionMandatory

ServiceCatalogID

INTEGER

Unique identification number of the Catalog.

  • If the Service Catalog has mandatory Custom Attributes, the strCustomAttributes is mandatory.
  • If the Service Catalog has mandatory Multivalued Custom Attributes, the strMvCustomAttributes is mandatory.

Note:

It is mandatory to provide either ServiceCatalogID or ServiceCatalogName value.

TRUE

ServiceCatalogName

STRING

Name of the Service Catalog.

TRUE

If ServiceCatalogID value is provided then it is not mandatory.

LogSRForUserMode

BOOLEAN

Is the SR logged for a user?

The values are constant and as follows:

  • TicketDetail if the Updater is an Executive.
  • LogTicket if the Updater is a Caller

FALSE

ServiceCategoryID

INTEGER

Unique Identification number of the Service Category.

The value is either true or false.

Note:

It is mandatory to provide either ServiceCategoryID or ServiceCategoryName value.

TRUE

ServiceCategoryName

STRING

Name of the Service Category.

TRUE

If ServiceCategoryID value is provided then it is not mandatory.

DelegationMode

BOOLEAN

Is the delegation enabled?

FALSE

WorkGroupID

STRING

Unique Identification number of the Work Group.

Note:

It is mandatory to provide either WorkGroupID or WorkGroupName value.

TRUE

WorkGroupName

STRING

Name of the Workgroup.

TRUE

If WorkGroupID value is provided then it is not mandatory.

DelegateeUserID

INTEGER

Unique Identification number of the user who is delegated with.

DelegateeUserID is a mandatory parameter if the DelegationMode parameter value is true.

FALSE

Org_ID

INTEGER

Unique Identification number of the Organization.

FALSE

ListCustomAttributes

ARRAY

Specify the list of Custom Attributes.

You can specify the following parameters:

  • RowID
  • Attribute_Type
  • Attribute_Name
  • Attribute_Value
  • Attribute_ID
  • Attribute_Text

FALSE

ListMVCustomAttributes

ARRAY

Specify the list of Multi Valued Custom Attributes.

You can specify the following parameters:

  • Attribute_Type
  • Attribute_Name
  • Attribute_Value
  • Attribute_ID

FALSE

JustificationRemarks

STRING

Specify the Remarks.

TRUE

NoOfApprovals

INTEGER

Specify the required number of Approvals.

Based on NoOfApprovals count, you need to provide approver details such as Approver, ApproverId, and ApproverName.

TRUE

SupportFunction

STRING

Name of the Instance.

For Example: Info

TRUE

Approver

STRING

Type of Approval.

TRUE

ApproverId

INTEGER

Unique Identification number of the Approver.

TRUE

ApproverName

STRING

Unique name of the Approver.

TRUE

Sample Response
{
    "Errors": "",
    "Message": null,
    "Output": "",
    "TokenID": null,
    "OrgID": 0,
    "OutputObject": {
        "Catalog Details": {
            "Message": "Successfully saved the service request. Service Request ID: SR2507",
            "SRId": "2507",
            "UploadControlUID": []
        }
    }
}

Status and Error Codes

For more information, see Status and Error Messages.