Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Updated the code macro with the following parameter(s): [theme]
Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
#F0F0F0#F0F0F0

3

Scroll export button
scopecurrent
template-id4fda9400-a7df-4ede-a95f-e4ae5fcf4796
captionDownload this Page
add-onScroll PDF Exporter

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


Code Block
titleSample Request
linenumberstrue
{
  "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

Status
colourGrey
titleinteger

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.

Status
colourGreen
titletrue

ServiceCatalogName

Status
colourGreen
titlestring

Name of the Service Catalog.

Status
colourGreen
titletrue

If ServiceCatalogID value is provided then it is not mandatory.

LogSRForUserMode

Status
colourBlue
titleBOOLEAN

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

Status
titleFALSE

ServiceCategoryID

Status
colourGrey
titleinteger

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.

Status
colourGreen
titletrue

ServiceCategoryName

Status
colourGreen
titlestring

Name of the Service Category.

Status
colourGreen
titletrue

If ServiceCategoryID value is provided then it is not mandatory.

DelegationMode

Status
colourBlue
titleBOOLEAN

Is the delegation enabled?

Status
titleFALSE

WorkGroupID

Status
colourGreen
titlestring

Unique Identification number of the Work Group.

Note:

It is mandatory to provide either WorkGroupID or WorkGroupName value.

Status
colourGreen
titletrue

WorkGroupName

Status
colourGreen
titlestring

Name of the Workgroup.

Status
colourGreen
titletrue

If WorkGroupID value is provided then it is not mandatory.

DelegateeUserID

Status
colourGrey
titleinteger

Unique Identification number of the user who is delegated with.

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

Status
titleFALSE

Org_ID

Status
colourGrey
titleinteger

Unique Identification number of the Organization.

Status
titleFALSE

ListCustomAttributes

Status
colourYellow
titleARRAY

Specify the list of Custom Attributes.

You can specify the following parameters:

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

Status
titleFALSE

ListMVCustomAttributes

Status
colourYellow
titleARRAY

Specify the list of Multi Valued Custom Attributes.

You can specify the following parameters:

  • Attribute_Type
  • Attribute_Name
  • Attribute_Value
  • Attribute_ID

Status
titleFALSE

JustificationRemarks

Status
colourGreen
titlestring

Specify the Remarks.

Status
colourGreen
titletrue

NoOfApprovals

Status
colourGrey
titleinteger

Specify the required number of Approvals.

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

Status
colourGreen
titletrue

SupportFunction

Status
colourGreen
titlestring

Name of the Instance.

For Example: Info

Status
colourGreen
titletrue

Approver

Status
colourGreen
titlestring

Type of Approval.

Status
colourGreen
titletrue

ApproverId

Status
colourGrey
titleinteger

Unique Identification number of the Approver.

Status
colourGreen
titletrue

ApproverName

Status
colourGreen
titlestring

Unique name of the Approver.

Status
colourGreen
titletrue

Code Block
titleSample Response
linenumberstrue
{
    "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.

Scroll ignore
scroll-pdftrue
scroll-officetrue
scroll-chmtrue
scroll-docbooktrue
scroll-eclipsehelptrue
scroll-epubtrue
scroll-htmltrue
1

| |