Get all service requests

get

/crmRestApi/resources/11.13.18.05/assets/{AssetId}/child/assetServiceRequests

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • MyCriticalSRsFinder: Finds critical service requests assigned to a user.
      Finder Variables:
      • AssigneeResourceId; string; The unique identifier of the assignee resource.
    • MySRsByStatusFinder: Finds service requests with a specific status that are assigned to a user.
      Finder Variables:
      • AssigneeResourceId; string; The unique identifier of the assignee resource.
      • StatusCd; string; The status code passed as parameter to the service request finder service.
    • MySRsFinder: Finds service requests assigned to the user.
      Finder Variables:
      • AssigneeResourceId; string; The unique identifier of the assignee resource.
    • PrimaryKey: Finds a service request by ID number.
      Finder Variables:
      • SrId; integer; The unique identifier of the service request.
    • SRListMySRTeamSRsFinder: Finds service requests where the logged in user belongs to the service request team.
      Finder Variables:
      • SRsByBillToCustomerAccountNumber: Finds a service request by customer account number.
        Finder Variables:
        • BillToCustomerAccountNumber; string; The unique identifier of the customer account to be billed.
      • SRsByBillToCustomerNumber: Finds a service request by the unique number of the customer to be billed.
        Finder Variables:
        • BillToCustomerNumber; string; The unique number of the customer to be billed.
      • SRsByServiceProfileNumber: Finds a service request by service profile number.
        Finder Variables:
        • ServiceProfileNumber; string; The unique number of the service profile.
      • SRsCreatedByMeFinder: Find a service request created by a user.
        Finder Variables:
        • CreatedBy; string; The user who created the service request.
      • SRsListByResource: Find service requests where a resource is on the service request team.
        Finder Variables:
        • ResourceId; integer; The unique identifier of the resource.
      • ServiceRequestByNumber: Finds a service request by SR number.
        Finder Variables:
        • SrNumber; string; The service request number passed as parameter to the finder service.
      • ServiceRequestByStripeCd: Finds service requests for an application stripe.
        Finder Variables:
        • StripeCd; string; The application stripe of the service request.
    • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
    • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

      Example:
      self,canonical
    • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
    • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

      Format: ?q=expression1;expression2

      You can use these queryable attributes to filter this collection resource using the q query parameter:
      • AccountPartyEmailAddress; string; Indicates the e-mail ID of the account on the service request.
      • AccountPartyId; integer; The unique party object ID of the account associated to the service request.
      • AccountPartyName; string; The party name associated with the account.
      • AccountPartyNumber; string; Indicates the alternate key for the account identifier.
      • AccountPartyPreferredContactMethod; string; Indicates the preferred contact method of the account on the service request.
      • AccountPartyUniqueName; string; The unique party name associated with the account.
      • AffectedPartyAssignmentNumber; string; The assignment number of the affected party.
      • AffectedPartyPersonName; string; Indicates the display name of the affected party person in the service request
      • AssetId; integer; The unique identifier of the asset associated to the service request.
      • AssetNumber; string; The Asset Number of the asset that is associated to the service request
      • AssetSerialNumber; string; The serial number of the asset that is associated to the service request.
      • AssigneePersonName; string; The email address of the assignee.
      • AssigneeResourceId; integer; The unique identifier of the resource (for example, a support engineer) assigned to the service request.
      • AssigneeResourceNumber; string; Indicates the alternative key for the resource identifier of the assignee.
      • BUOrgId; integer; The unique identifier of the business unit name associated to the service request.
      • BillToCustomerAccountDescription; string; The description of the customer account to be billed for work performed on the service request.
      • BillToCustomerAccountId; integer; The customer account to be billed for work performed on the service request.
      • BillToCustomerAccountNumber; string; The PUID for the customer account to be billed for work performed on the service request.
      • BillToCustomerAccountSiteId; integer; The customer account site to be billed for work performed on the service request.
      • BillToCustomerAccountSiteUsageNumber; string; The PUID for the customer account site bill-to usage.
      • BillToCustomerId; integer; The customer to be billed for work performed on the service request.
      • BillToCustomerName; string; The name of the customer to be billed for work performed on the service request.
      • BillToCustomerNumber; string; The PUID for the customer to be billed for work performed on the service request.
      • BillToPartySiteFormattedAddress; string; The formatted address for the customer site to be billed for work performed on the service request.
      • BillToPartySiteId; integer; The address of the customer site to be billed for work performed on the service request.
      • BillToPartySiteLocationId; integer; The location of the customer site to be billed for work performed on the service request.
      • BillToPartySiteName; string; The name of the customer site to be billed for work performed on the service request.
      • BillToPartySiteNumber; string; The PUID for the customer site to be billed for work performed on the service request.
      • CaseId; integer; Indicates the case to which this service request has been associated.
      • CategoryCode; string; Indicates the alternate key of the category associated to the service request.
      • CategoryId; integer; The unique identifier of the service request category.
      • CategoryName; string; The name of the category associated to the service request.
      • ChannelTypeCd; string; Indicates the channel type.
      • ChannelTypeCdMeaning; string; Indicates the display value corresponding to the channel type lookup code for the service request.
      • ClosedDate; string; The date when the service request was closed (if closed).
      • ComplianceFlag; boolean; Indicates the compliance status of the milestone.
      • CreatedBy; string; The user who created the service request.
      • CreationDate; string; The date and time when the service request was created.
      • CriticalFlag; boolean; Indicates whether the service request is critical. If critical, the value is Y, else the value is N.
      • DueDate; string; Indicates the due date of the milestone.
      • FirstTransferDate; string; Indicates the date and time of the first transfer of the service request.
      • HeaderFlag; boolean; Indicates if the current milestone should be saved on the service request header.
      • IBAssetDescription; string; Indicates the Install Base asset description of the service request.
      • IBAssetId; integer; The unique identifier of the associated Install Base asset record.
      • IBAssetLocationType; string; Indicates the type of location of the asset of the service request.
      • IBAssetNumber; string; Indicates the Installed Base asset number of the service request.
      • IBAssetSerialNumber; string; Indicates the Install Base asset serial number of the service request.
      • InternalPriorityCd; string; Indicates the internal priority of the service request.
      • InventoryItemId; integer; The unique identifier of the product associated to the service request.
      • InventoryOrgId; integer; The unique identifier of the organization of the product that is associated with the service request.
      • LanguageCd; string; The customer's preferred language for the service request.
      • LastReopenDate; string; The date and time when the service request was last reopened.
      • LastResolvedDate; string; The date and time when the service request was resolved.
      • LastTransferDate; string; Indicates the date and time of the last transfer of the service request.
      • LastTransferredBy; string; Indicates the user who last transferred the service request.
      • LastUpdateDate; string; The date and time when the service request was last updated.
      • LastUpdatedBy; string; The user who last updated the service request.
      • LastUpdatedByDisplayName; string; The display name of the user who last updated the service request.
      • LastUpdatedByEmailAddress; string; Indicates the e-mail address of the person who last updated the service request.
      • LastUpdatedByPartyId; integer; Indicates the unique identifier of the person who last updated the service request.
      • LoyMemberId; integer; The unique identifier of the loyalty membership.
      • LoyMemberName; string; The member name of the loyalty membership.
      • LoyMemberNumber; string; Indicates the alternative key for the loyalty member identifier.
      • MilestoneConfigId; integer; The unique identifier of the milestone configuration associated with the service request.
      • MilestoneLabel; string; The user defined name for the milestone.
      • MilestoneStatusCd; string; Indicates the status of the milestone.
      • OpenDate; string; The date when the service request was reported by the customer.
      • OriginalSystemReference; string; The reference to the service request record in the original system from which service request was imported (if imported).
      • PartnerAccountPartyId; integer; The unique party object ID of the partner account associated with the service request.
      • PartnerAccountPartyNumber; string; Indicates the alternative key for the partner account identifier.
      • PartnerAccountPartyUniqueName; string; The unique party name associated with the partner.
      • PrimaryContactAssignmentNumber; string; The assignment number of the primary contact.
      • PrimaryContactDoNotContactFlag; boolean; Indicates that the primary contact of the service request does not want to be contacted.
      • PrimaryContactPartyId; integer; The unique identifier of the contact who initially reported the service request. The contact is also the primary contact of the service request.
      • PrimaryContactPartyName; string; Indicates the name of the service request primary contact.
      • PrimaryContactPartyNumber; string; Indicates the alternative key for the primary contact identifier.
      • PrimaryContactPartyUniqueName; string; The unique party name associated with the primary contact.
      • PrimaryContactPersonId; integer; The unique identifier of the contact who initially reported the service request. The contact is also the primary contact of the service request.
      • PrimaryContactPreferredContactMethod; string; Indicates the preferred contact method of the primary contact of the service request.
      • ProblemCd; string; Indicates the problem code of the service request.
      • ProblemDescription; string; The service request's problem description/statement and the steps to reproduce the issue.
      • ProdGroupName; string; The name of the product group associated to the service request.
      • ProductGroupReferenceNumber; string; Indicates the alternative key for the product group identifier.
      • ProductItemDescription; string; The description of the product associated with the service request.
      • ProductItemNumber; string; The product number/code of the product associated with the service request.
      • QueueId; integer; The unique identifier of the queue to which the service request is assigned.
      • QueueName; string; The name of the queue associated to the service request.
      • QueueNumber; string; Indicates the alternative key for the queue identifier.
      • RecordSet; string; The field is used by REST API to manage saved searches.
      • ReportedByEmailAddress; string; Indicates the e-mail address of the person who reported the service request.
      • ReportedByPartyId; integer; The user who created the service request in the system.
      • ReportedByPartyName; string; The name of the party that reported the service request.
      • ReportedByPartyNumber; string; Indicates the alternative key for the party identifier of the person reporting the service request.
      • ReportedByPartyUniqueName; string; The unique name of the user who created the service request.
      • ResolutionCd; string; Indicates the resolution code of the service request.
      • ResolutionCdMeaning; string; Indicates the display value corresponding to the resolution lookup code for the service request.
      • ResolveDescription; string; Indicates how the service request has been resolved.
      • ResolveOutcomeCd; string; Indicates the outcome of a service request resolution.
      • ResolveOutcomeCdMeaning; string; Indicates the display value corresponding to the resolution outcome lookup code for the service request.
      • ResolvedBy; string; Indicates the user who resolved the service request.
      • ServiceProfileId; integer; The service profile associated with the service request.
      • ServiceProfileName; string; The name of the service profile associated with the service request.
      • ServiceProfileNumber; string; The PUID for the service profile associated with the service request.
      • ServiceProfilePartySiteId; integer; The address of the service profile associated with the service request.
      • ServiceProfilePartySiteLocationId; integer; The location of the service profile associated with the service request.
      • ServiceProfilePartySiteName; string; The name of the address of the service profile associated with the service request.
      • ServiceProfilePartySiteNumber; string; The PUID of the address of the service profile associated with the service request.
      • ServiceProfileSiteFormattedAddress; string; The formatted address of the service profile associated with the service request.
      • ServiceZoneId; integer; The unique identifier of the service zone for the service request.
      • ServiceZoneName; string; Indicates the service region of the service request.
      • SeverityCd; string; Indicates the severity of the service request.
      • SeverityCdMeaning; string; Indicates the display value corresponding to the severity lookup code for the service request.
      • SeverityRank; integer; Indicates the numeric code of the service request severity.
      • SocialPrivateFlag; boolean; Indicates if the service request was created from a private social post.
      • SourceCd; string; Indicates how the service request was created in the application.
      • SrId; integer; The unique identifier of the service request record.
      • SrMilestoneId; integer; The unique identifier of the milestone associated to the service request.
      • SrNumber; string; The unique number that is used to identify a service request. You can customize the service request Number to a format that is best suitable to your organizational requirements.
      • StatusCd; string; Indicates the status code of the service request.
      • StatusCdMeaning; string; Indicates the display value corresponding to the status lookup code for the service request.
      • StatusTypeCd; string; Indicates the status type of the service request.
      • StatusTypeCdMeaning; string; Indicates the display value corresponding to the status type lookup code for the service request.
      • StripeCd; string; Indicates the application context of the service request.
      • SurveyResponseDate; string; The date and time when the response to this survey was submitted to the survey vendor.
      • SurveySentDate; string; The date and time when survey was last sent for this service request.
      • TimeRemaining; string; Indicates the time remaining in the milestone
      • TimezoneCode; string; The service request time zone used for computing the milestone due date.
      • Title; string; A brief title of the service request.
      • TransferCount; integer; The number of times a service request has been transferred.
      • TransferNote; string; This field contains information about transfer note.
      • TransferReasonCd; string; The lookup code that represents the transfer reason.
      • UniqueExternalSystemReference; string; The unique alternative identifier of the service request in the original reference system. Use this column to store the identifier of the service request in the external application you are integrating with.
      • WarnedFlag; boolean; Indicates that the milestone passed the warning threshold.
    • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
    Header Parameters
    • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
    • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

    There's no request body for this operation.

    Back to Top

    Response

    Supported Media Types

    Default Response

    The following table describes the default response for this task.
    Headers
    • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
    • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
    Body ()
    Root Schema : assets-assetServiceRequests
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : assets-assetServiceRequests-item-response
    Type: object
    Show Source
    Back to Top