Jump to

• Request
• Response

Update a trigger definition

patch

/fscmRestApi/resources/11.13.18.05/publicSectorCodeEnforcementTimeRuleTriggers/{TriggerId}

Request

Path Parameters

• TriggerId(required): string
  The unique identifier of the trigger definition.

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• AppModulePath: string
  Title: Application Module Path

  Maximum Length: 4000

  The application module where the view object is registered.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates if the trigger definition is logically deleted (Yes or No). Valid values are "Y" for a deleted record, and "N" for an active record. The default value is "N".
• Description: string
  Title: Description

  Maximum Length: 256

  The description of the trigger.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates if the trigger is available for use.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates if the row is seed data. Valid values are "0" for customer data, "1" for seed data that cannot be modified, and a value more than "1"indicates that the seed data can be modified.
• TriggerField: string
  Title: Trigger Record Field

  Maximum Length: 256

  The record field on which the trigger is created.
• TriggerRecord: string
  Title: Trigger Record

  Maximum Length: 150

  The record on which the trigger is created.
• Viewobjectattribute: string
  Title: View Object Attribute

  Maximum Length: 1000

  The view object attribute on which the trigger is created.
• Viewobjectname: string
  Title: View Object Name

  Maximum Length: 150

  The name of the view object on which the trigger is created.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":256,
            "type":"string",
            "description":"The description of the trigger.",
            "nullable":false
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the row is seed data. Valid values are \"0\" for customer data, \"1\" for seed data that cannot be modified, and a value more than \"1\"indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            }
        },
        "Viewobjectname":{
            "title":"View Object Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the view object on which the trigger is created.",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the trigger definition is logically deleted (Yes or No). Valid values are \"Y\" for a deleted record, and \"N\" for an active record. The default value is \"N\".",
            "nullable":false,
            "default":"N"
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the trigger is available for use.",
            "nullable":false,
            "default":"Y"
        },
        "TriggerRecord":{
            "title":"Trigger Record",
            "maxLength":150,
            "type":"string",
            "description":"The record on which the trigger is created.",
            "nullable":true
        },
        "TriggerField":{
            "title":"Trigger Record Field",
            "maxLength":256,
            "type":"string",
            "description":"The record field on which the trigger is created.",
            "nullable":true
        },
        "Viewobjectattribute":{
            "title":"View Object Attribute",
            "maxLength":1000,
            "type":"string",
            "description":"The view object attribute on which the trigger is created.",
            "nullable":true
        },
        "AppModulePath":{
            "title":"Application Module Path",
            "maxLength":4000,
            "type":"string",
            "description":"The application module where the view object is registered.",
            "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(required):
  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(required):
  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 : publicSectorCodeEnforcementTimeRuleTriggers-item-response

Type: object

Show Source

• AppModulePath: string
  Title: Application Module Path

  Maximum Length: 4000

  The application module where the view object is registered.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the row was created.
• DeletedFlag: string
  Maximum Length: 1

  Default Value: N

  Indicates if the trigger definition is logically deleted (Yes or No). Valid values are "Y" for a deleted record, and "N" for an active record. The default value is "N".
• Description: string
  Title: Description

  Maximum Length: 256

  The description of the trigger.
• EnabledFlag: string
  Title: Enabled

  Maximum Length: 1

  Default Value: Y

  Indicates if the trigger is available for use.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The name of the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates if the row is seed data. Valid values are "0" for customer data, "1" for seed data that cannot be modified, and a value more than "1"indicates that the seed data can be modified.
• TriggerField: string
  Title: Trigger Record Field

  Maximum Length: 256

  The record field on which the trigger is created.
• TriggerId: string
  Title: Trigger ID

  Maximum Length: 50

  The unique identifier of the trigger definition.
• TriggerRecord: string
  Title: Trigger Record

  Maximum Length: 150

  The record on which the trigger is created.
• Viewobjectattribute: string
  Title: View Object Attribute

  Maximum Length: 1000

  The view object attribute on which the trigger is created.
• Viewobjectname: string
  Title: View Object Name

  Maximum Length: 150

  The name of the view object on which the trigger is created.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":256,
            "type":"string",
            "description":"The description of the trigger.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates if the row is seed data. Valid values are \"0\" for customer data, \"1\" for seed data that cannot be modified, and a value more than \"1\"indicates that the seed data can be modified.",
            "format":"int32",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":1
            },
            "x-queryable":true
        },
        "Viewobjectname":{
            "title":"View Object Name",
            "maxLength":150,
            "type":"string",
            "description":"The name of the view object on which the trigger is created.",
            "nullable":true,
            "x-queryable":true
        },
        "TriggerRecord":{
            "title":"Trigger Record",
            "maxLength":150,
            "type":"string",
            "description":"The record on which the trigger is created.",
            "nullable":true,
            "x-queryable":true
        },
        "TriggerField":{
            "title":"Trigger Record Field",
            "maxLength":256,
            "type":"string",
            "description":"The record field on which the trigger is created.",
            "nullable":true,
            "x-queryable":true
        },
        "AppModulePath":{
            "title":"Application Module Path",
            "maxLength":4000,
            "type":"string",
            "description":"The application module where the view object is registered.",
            "nullable":true,
            "x-queryable":true
        },
        "TriggerId":{
            "title":"Trigger ID",
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the trigger definition.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the trigger definition is logically deleted (Yes or No). Valid values are \"Y\" for a deleted record, and \"N\" for an active record. The default value is \"N\".",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"string",
            "description":"Indicates if the trigger is available for use.",
            "nullable":false,
            "default":"Y",
            "x-queryable":true
        },
        "Viewobjectattribute":{
            "title":"View Object Attribute",
            "maxLength":1000,
            "type":"string",
            "description":"The view object attribute on which the trigger is created.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "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