Jump to

• Request
• Response

Get all action request payload definitions

get

/crmRestApi/resources/11.13.18.05/serviceProfiles/{serviceProfiles_Id}/child/smartActions/{serviceProfiles_smartActions_Id}/child/UserActionRequestPayload

Request

Path Parameters

• serviceProfiles_Id(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• serviceProfiles_smartActions_Id(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Query Parameters

• dependency: string
  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>
• expand: string
  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).
• fields: string
  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
• finder: string
  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
  
  

  • PrimaryKey The PrimaryKey finder defined on the UserActionRequestPayload resource.
    Finder Variables
    • RequestPayloadId; integer; The RequestPayloadId; integer; bind variable for the PrimaryKey finder.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • ContactEmailAddress; string; The email address of the contact belonging to the service profile.
  • ContactPartyName; string; The name of the contact belonging to the service profile.
  • ContactPartyNumber; string; The PUID of the contact belonging to the service profile.
  • ContactPartyUniqueName; string; The unique name of the contact belonging to the service profile.
  • CreatedBy; string; The user that created the service profile contact.
  • CreationDate; string; The date when the service profile contact was created.
  • JobTitle; string; The job title of the contact belonging to the service profile.
  • LastUpdateDate; string; The date when the service profile contact was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the service profile contact.
  • LastUpdatedBy; string; The user who last updated the service profile contact.
  • PartyId; integer; The contact for the service profile contact.
  • ServiceProfileId; integer; The service profile for the service profile contact.
  • ServiceProfileName; string; The name of the service profile for the service profile contact.
  • ServiceProfileNumber; string; The PUID of the service profile for the service profile contact.
  • SpContactId; integer; The unique identifier of the service profile contact.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Binding; string; This is a hint for processing the Url Binding runtime.
  • SystemActionFlag; boolean; Boolean indicator.
  • URLBindingId; integer; Uniquely identifies the URL Bind for smart actions. For internal use.
  • URLBindingName; string; For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Value; string; For action REST endpoints that require runtime binding, this is the value in the key value pair.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • BillToAccountSiteFormattedAddress; string; The formatted address to be billed for work performed for the service profile.
  • BillToCustomerAccountDescription; string; The description of the customer account to be billed for work performed for the service profile.
  • BillToCustomerAccountId; integer; The customer account to be billed for work performed for the service profile.
  • BillToCustomerAccountNumber; string; The PUID for the customer account to be billed for work performed for the service profile.
  • BillToCustomerAccountSiteId; integer; The customer account site to be billed for work performed for the service profile.
  • BillToCustomerId; integer; The customer to be billed for work performed for the service profile.
  • BillToCustomerPartyName; string; The name of the customer to be billed for work performed for the service profile.
  • BillToCustomerPartyNumber; string; The PUID for the customer to be billed for work performed for the service profile.
  • BillToCustomerPartyUniqueName; string; The unique name of the customer to be billed for work performed for the service profile.
  • BillToPartySiteId; integer; The party site to be billed for work performed for the service profile.
  • BillToPartySiteName; string; The name given to the party site that will be billed for work performed for the service profile.
  • BillToPartySiteNumber; string; The PUID for the party site that will be billed for work performed for the service profile.
  • BillingBUOrgId; integer; The business unit that maintains the billing address for the service profile.
  • CreatedBy; string; The user who created the service profile.
  • CreationDate; string; The date when the service profile was created.
  • CustomerPartyId; integer; The customer having the service profile.
  • CustomerPartyName; string; The name of the service profile customer.
  • CustomerPartyNumber; string; The PUID for the customer party of the service profile.
  • CustomerPartyType; string; Indicates whether the service profile customer is a person or organization.
  • CustomerPartyUniqueName; string; The unique name of the service profile customer.
  • LastUpdateDate; string; The date when the service profile was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the service profile.
  • LastUpdatedBy; string; The user who last updated the service profile.
  • PartySiteAddress1; string; The first address line for the service profile site address.
  • PartySiteAddress2; string; The second address line for the service profile site address.
  • PartySiteAddress3; string; The third address line for the service profile site address.
  • PartySiteAddress4; string; The fourth address line for the service profile site address.
  • PartySiteBuilding; string; The building information for the service profile site address.
  • PartySiteCity; string; The city for the service profile site address.
  • PartySiteCountry; string; The country for the service profile site address.
  • PartySiteCounty; string; The county for the service profile site address.
  • PartySiteFloorNumber; string; The floor in the building for the service profile site address.
  • PartySiteFormattedAddress; string; The formatted site address of the service profile.
  • PartySiteId; integer; The site address of the service profile.
  • PartySiteLatitude; number; The latitude coordinate for the service profile site address.
  • PartySiteLocationId; integer; The location identifier for the service profile site address.
  • PartySiteLongitude; number; The longitude coordinate for the service profile site address.
  • PartySiteName; string; The name given to the service profile site address.
  • PartySiteNumber; string; The PUID of the service profile site address.
  • PartySitePartyId; integer; The party of the service profile site address.
  • PartySitePartyName; string; The name of the party of the service profile site address.
  • PartySitePartyUniqueName; string; The unique name of the part of the service profile site address.
  • PartySitePostalCode; string; The postal code for the service profile site address.
  • PartySiteProvince; string; The province for the service profile site address.
  • PartySiteState; string; The state for the service profile site address.
  • PartySiteTimezoneCode; string; The time zone for the service profile site address.
  • PrimaryContactPartyId; integer; The primary contact of the service profile.
  • PrimaryContactPartyName; string; The name of the service profile primary contact.
  • PrimaryContactPartyNumber; string; The party number of the service profile primary contact.
  • ServiceProfileId; integer; The unique identifier of the service profile.
  • ServiceProfileName; string; The name of the service profile.
  • ServiceProfileNumber; string; The PUID of the service profile.
  • StatusCd; string; Indicates whether the service profile is active.
  • StripeCd; string; Indicates the type of service implementation for the service profile. For example, CRM or Internal Help Desk service profile.
  • TypeCd; string; The type of service profile.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ContactRelationshipId; integer; The relationship ID populated when the note is associated with a contact.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date when the record was created.
  • CreatorPartyId; integer; The unique identifier of the party.
  • EmailAddress; string; The email address of the user who created the note.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the record.
  • LastUpdatedBy; string; The unique identifier of the note. This is the primary key of the notes table.
  • NoteId; integer; The unique identifier of the note. This is the primary key of the notes table.
  • NoteNumber; string; The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • NoteTitle; string; The title of the note entered by the user.
  • NoteTxt; string; The column which stores the actual note text.
  • NoteTypeCode; string; The note type code for categorization of note.
  • ParentNoteId; integer; The unique identifier of the note. This is the primary key of the notes table.
  • PartyId; integer; The unique identifier of the party.
  • PartyName; string; The name of the party.
  • SourceObjectCode; string; This is the source object code for the source object as defined in OBJECTS Metadata.
  • SourceObjectId; string; The unique identifier of the parent source object associated to the note.
  • SourceSystem; string; This is the source object code for the source object as defined in OBJECTS Metadata.
  • VisibilityCode; string; The attribute to specify the visibility level of the note. It indicates whether the note is internal, external, or private.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • Binding; string; Indicates the binding type of the value.
  • MandatoryFlag; boolean; Boolean value indicating if the payload is mandatory.
  • RequestPayloadId; integer; Uniquely identifies the payload for smart actions. For internal use.
  • RequestPayloadName; string; The key in the Key Value pair that forms the payload.
  • SmartSuggestPath; string; The path used for smart suggest.
  • SystemActionFlag; boolean; Boolean value.
  • Value; string; The value in the Key Value pair that forms the payload.
  • ValueStruct; string; If the value in the Key Value pair isn't a single value, this would be set.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ConfirmationMessage; string; A message to seek confirmation for the action being performed.
  • ContentType; string; The content type to use when invoking the REST endpoint.
  • DisplayLabel; string; Consumer-friendly action name.
  • Entity; string; REST Resources the action belongs to.
  • Href; string; The REST endpoint to perform the action.
  • IncludedInApplication; string; List of applications that this action can be used in.
  • MassActionFlag; boolean; Boolean type indicating if this action can be mass processed.
  • Method; string; HTTP method to use with HREF.
  • ObjectFunctionName; string; The object function associated with the smart action.
  • PageType; string; The list of pages that this action can be used in.
  • SmartSuggestFlag; boolean; Indicates if smart suggest is enabled for the action.
  • SystemActionFlag; boolean; Boolean type indicating if the action is seeded or custom.
  • UpdateOfAttributes; string; Attributes to be updated when the Actions UI is launched.
  • UserActionId; integer; Uniquely identifies the action. For internal use.
  • UserActionName; string; Uniquely identifies the action with a name. For internal use.
  • UserActionRank; integer; Number to indicate priority of the action.

  
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • SystemActionFlag; boolean; Boolean value indicating if the action is seeded or custom.
  • UserActionNavAppUsage; string; Application usage.
  • UserActionNavBody; string; Metadata of the navigation as needed for the specific usage.
  • UserActionNavId; integer; Primary key for the user action navigation.
  • UserActionNavType; string; Provision for having multiple navigation flows for a given usage.
• totalResults: boolean
  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

• Metadata-Context: string
  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".
• REST-Framework-Version: string
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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 : serviceProfiles-smartActions-UserActionRequestPayload

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/serviceProfiles-smartActions-UserActionRequestPayload-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object serviceProfiles-smartActions-UserActionRequestPayload-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/serviceProfiles-smartActions-UserActionRequestPayload-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 : serviceProfiles-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the binding type of the value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Boolean value indicating if the payload is mandatory.
• RequestPayloadId: integer (int64)
  Uniquely identifies the payload for smart actions. For internal use.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The key in the Key Value pair that forms the payload.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  Boolean value.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value in the Key Value pair that forms the payload.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  If the value in the Key Value pair isn't a single value, this would be set.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the binding type of the value.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"If the value in the Key Value pair isn't a single value, this would be set.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value in the Key Value pair that forms the payload.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"Uniquely identifies the payload for smart actions. For internal use.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The key in the Key Value pair that forms the payload.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Boolean value indicating if the payload is mandatory.",
            "nullable":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