Jump to

• Request
• Response

Get all contact members

get

/api/boss/data/objects/ora/cxServiceCore/srMgmt/v1/serviceRequests/{serviceRequests_id}/contacts

Request

Path Parameters

• serviceRequests_id(required): string
  This path parameter maps to the following field defined in the Service Requests REST resource:
  

  1. number: The unique number that's used to identify a service request. You can edit the service request number to a format that's best suitable to your organizational requirements.

Query Parameters

• $fields: string
  Restricts the resource fields. Only the specified fields and mandatory system fields are returned.
• $filter: string
  The resource collection will be queried using the specified filter condition.
• $limit: integer
  Restricts the number of resource items returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resource items.

  Default Value: 25
• $offset: integer
  Defines the starting position of the resource collection. If offset exceeds the resource count then no resource items are returned.

  Default Value: 0
• $sortBy: string
  Orders a resource collection based on the specified fields. The parameter value is a comma-separated string of field names, each optionally followed by a colon and "asc" (default) or "desc".

There's no request body for this operation.

Back to Top

Response

Default Response

An array of items response

Body ()

Root Schema : serviceRequests-contacts

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/serviceRequests-contacts-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object serviceRequests-contacts-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/serviceRequests-contacts-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : serviceRequests-contacts-item-response

Type: object

Show Source

• AccessLevelCd: string
  Title: Access Level

  Maximum Length: 30

  The service request access level granted to the contact.
• AccountName: string
  Title: Account Name

  Read Only: true

  Maximum Length: 900

  The primary account of the service request contact.
• ContactEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the party associated with the contact.
• ContactFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the party associated with the contact.
• ContactPartyName: string
  Title: Name

  Maximum Length: 360

  The name of a service request contact.
• ContactPartyNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier of the contact associated with the service request.
• ContactPreferredContactMethod: string
  Title: Preferred Contact Method

  Read Only: true

  Maximum Length: 30

  The preferred contact method of the party associated with the contact.
• ContactTypeCd: string
  Title: Contact Type

  Maximum Length: 30

  The service request contact type such as Customer or Partner.
• ContactUniqueName: string
  Title: Unique Name

  Maximum Length: 900

  The unique party name associated with the contact.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• DeleteFlag: boolean
  Title: Can Delete

  Read Only: true

  Indicates if the contact has been deleted.
• DoNotContactFlag: boolean
  Title: Do Not Contact

  Read Only: true

  Maximum Length: 1

  Indicates whether the contact of the service request does not want to be contacted. The default value is false.
• FormattedAddress: string
  Title: Formatted Address

  Read Only: true

  The formatted address of the service request contact.
• JobTitle: string
  Title: Job Title

  Read Only: true

  Maximum Length: 100

  The job title of the service request contact.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The application login id of the user who last updated the contacts object associated with the service request.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberId: integer (int64)
  Title: Member ID

  The unique identifier of the contact.
• PartyId: integer (int64)
  Title: Party ID

  The unique party identifier of the contact.
• PersonId: integer (int64)
  Title: Person ID

  The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request.
• PrimaryContactFlag: boolean
  Title: Primary

  Indicates if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false.
• RelationTypeCd: string
  Title: Relationship Type Code

  Maximum Length: 30

  The code indicating the type of relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.
• SrId: integer (int64)
  Title: Service Request ID

  The unique identifier of the associated service request.
• SrNumber: string
  Title: Service Request Number

  Maximum Length: 30

  The public unique number of the a service request.
• UpdateFlag: boolean
  Title: Can Update

  Read Only: true

  Indicates if the contact has been updated.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryContactFlag":{
            "title":"Primary",
            "type":"boolean",
            "description":"Indicates if the contact is the primary contact for the service request. If yes, the value is True, else the value is False. The default value is false.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            }
        },
        "RelationTypeCd":{
            "title":"Relationship Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of relationship with the contact in context of the service request. For example, Alternate, Follower, Third_Party, and so on.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactUniqueName":{
            "title":"Unique Name",
            "maxLength":900,
            "type":"string",
            "description":"The unique party name associated with the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AccessLevelCd":{
            "title":"Access Level",
            "maxLength":30,
            "type":"string",
            "description":"The service request access level granted to the contact.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The job title of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactPartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of a service request contact.",
            "nullable":false,
            "x-queryable":true
        },
        "MemberId":{
            "title":"Member ID",
            "type":"integer",
            "description":"The unique identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the contact has been updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPreferredContactMethod":{
            "title":"Preferred Contact Method",
            "maxLength":30,
            "type":"string",
            "description":"The preferred contact method of the party associated with the contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SrId":{
            "title":"Service Request ID",
            "type":"integer",
            "description":"The unique identifier of the associated service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the party associated with the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ContactPersonalPhoneFlag",
                    "ContactPrimaryPhoneAreaCode",
                    "ContactPrimaryPhoneContactPtId",
                    "ContactPrimaryPhoneCountryCode",
                    "ContactPrimaryPhoneExtension",
                    "ContactPrimaryPhoneLineType",
                    "ContactPrimaryPhoneNumber"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Formatted Address",
            "type":"string",
            "description":"The formatted address of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ContactIdenAddrLocationId"
                ]
            }
        },
        "SrNumber":{
            "title":"Service Request Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique number of the a service request.",
            "nullable":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the contact has been deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the contact associated with the service request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactEmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the party associated with the contact.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DoNotContactFlag":{
            "title":"Do Not Contact",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the contact of the service request does not want to be contacted. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique party identifier of the contact.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "title":"Person ID",
            "type":"integer",
            "description":"The unique identification of a person that is a contact on a service request.This is only used for human resource help desk service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContactTypeCd":{
            "title":"Contact Type",
            "maxLength":30,
            "type":"string",
            "description":"The service request contact type such as Customer or Partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The application login id of the user who last updated the contacts object associated with the service request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccountName":{
            "title":"Account Name",
            "maxLength":900,
            "type":"string",
            "description":"The primary account of the service request contact.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top