Jump to

• Request
• Response

Update an action event

patch

/crmRestApi/resources/11.13.18.05/actionEvents/{RequestActionCaptureId}

Request

Path Parameters

• RequestActionCaptureId(required): integer(int64)
  The unique identifier of the action event capture.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• RequestActionCaptureId: integer (int64)
  Title: Request Action Capture ID

  The unique identifier of the action event capture.
• ResponseCode: string
  Title: Response Code

  Maximum Length: 50

  The response status code of the REST API called.
• ResponsePayload: string
  Title: Response Payload

  Maximum Length: 4000

  The output of the REST API call.

{
    "type":"object",
    "properties":{
        "RequestActionCaptureId":{
            "title":"Request Action Capture ID",
            "type":"integer",
            "description":"The unique identifier of the action event capture.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResponseCode":{
            "title":"Response Code",
            "maxLength":50,
            "type":"string",
            "description":"The response status code of the REST API called.",
            "nullable":true
        },
        "ResponsePayload":{
            "title":"Response Payload",
            "maxLength":4000,
            "type":"string",
            "description":"The output of the REST API call.",
            "nullable":true
        }
    }
}

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 : actionEvents-item-response

Type: object

Show Source

• ActionType: string
  Title: Action Type

  Maximum Length: 30

  The REST API method used.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the action event was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the action event was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

  The login details of the user who last updated the action event record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProductFamily: string
  Title: Product Family

  Maximum Length: 30

  Default Value: CRM

  The product family of the invoked REST API, such as CRM.
• ProxyUserFlag: boolean
  Title: Is Proxy User

  Maximum Length: 1

  Indicates whether the session user is an end user or a proxy user.
• RequestActionCaptureId: integer (int64)
  Title: Request Action Capture ID

  The unique identifier of the action event capture.
• RequestDate: string (date-time)
  Title: Request Date

  The date when the REST API was invoked.
• RequestHeader: string
  Title: Request Header

  Maximum Length: 2000

  The request header that should is included when making a REST call.
• RequestPayload: string
  Title: Request Payload

  Maximum Length: 3000

  The payload containing the details of the incoming REST API call.
• RequestURI: string
  Title: Request URI

  Maximum Length: 1000

  The request URI pattern that matches the REST API call.
• RequestURL: string
  Title: Request URL

  Maximum Length: 1000

  The full URL of the REST request including the parameters.
• ResponseCode: string
  Title: Response Code

  Maximum Length: 50

  The response status code of the REST API called.
• ResponsePayload: string
  Title: Response Payload

  Maximum Length: 4000

  The output of the REST API call.
• SessionId: string
  Title: Session ID

  Maximum Length: 200

  The login details of the user. This attribute is used to track contiguous usage of REST API in applications like digital customer service.
• SessionTypeId: integer (int64)
  Title: Session Type ID

  The unique identifier of the session type.
• SessionUser: string
  Title: Session User

  Maximum Length: 64

  The logged in user calling the REST API.

{
    "type":"object",
    "properties":{
        "ActionType":{
            "title":"Action Type",
            "maxLength":30,
            "type":"string",
            "description":"The REST API method used.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the action event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the action event was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the  action event was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the action event record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the action event record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductFamily":{
            "title":"Product Family",
            "maxLength":30,
            "type":"string",
            "description":"The product family of the invoked REST API, such as CRM.",
            "nullable":false,
            "default":"CRM",
            "x-queryable":true
        },
        "ProxyUserFlag":{
            "title":"Is Proxy User",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the session user is an end user or a proxy user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RequestActionCaptureId":{
            "title":"Request Action Capture ID",
            "type":"integer",
            "description":"The unique identifier of the action event capture.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestDate":{
            "title":"Request Date",
            "type":"string",
            "description":"The date when the REST API was invoked.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "RequestHeader":{
            "title":"Request Header",
            "maxLength":2000,
            "type":"string",
            "description":"The request header that should is included when making a REST call.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayload":{
            "title":"Request Payload",
            "maxLength":3000,
            "type":"string",
            "description":"The payload containing the details of the incoming REST API call.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestURI":{
            "title":"Request URI",
            "maxLength":1000,
            "type":"string",
            "description":"The request URI pattern that matches the REST API call.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestURL":{
            "title":"Request URL",
            "maxLength":1000,
            "type":"string",
            "description":"The full URL of the REST request including the parameters.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponseCode":{
            "title":"Response Code",
            "maxLength":50,
            "type":"string",
            "description":"The response status code of the REST API called.",
            "nullable":true,
            "x-queryable":true
        },
        "ResponsePayload":{
            "title":"Response Payload",
            "maxLength":4000,
            "type":"string",
            "description":"The output of the REST API call.",
            "nullable":true,
            "x-queryable":true
        },
        "SessionId":{
            "title":"Session ID",
            "maxLength":200,
            "type":"string",
            "description":"The login details of the user. This attribute is used to track contiguous usage of REST API in applications like digital customer service.",
            "nullable":false,
            "x-queryable":true
        },
        "SessionTypeId":{
            "title":"Session Type ID",
            "type":"integer",
            "description":"The unique identifier of the session type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SessionUser":{
            "title":"Session User",
            "maxLength":64,
            "type":"string",
            "description":"The logged in user calling the REST API.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Links

YesNoLookupPVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DYES_NO

The following properties are defined on the LOV link relation:

• Source Attribute: ProxyUserFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top