Jump to

• Request
• Response

Update an action

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions/{ActionId}

Request

Path Parameters

• ActionId(required): integer(int64)
  The unique identifier for this action.

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 ()

Root Schema : schema

Type: object

Show Source

• ActionCode: string
  Maximum Length: 32

  The unique identifier of the resource action associated with this condition.
• ActionParameter1: string
  Maximum Length: 2048

  The first field for storing action parameter values required by the resource action associated with this action.
• ActionParameter2: string
  Maximum Length: 2048

  The second field for storing action parameter values required by the resource action associated with this action.
• ActionParameter3: string
  Maximum Length: 2048

  The third field for storing action parameter values required by the resource action associated with this action.
• ActionParameter4: string
  Maximum Length: 2048

  The fourth field for storing action parameter values required by the resource action associated with this action.
• ActionParameter5: string
  Maximum Length: 2048

  The fifth field for storing action parameter values required by the resource action associated with this action.
• ActionParameter6: string
  Maximum Length: 2048

  The sixth field for storing action parameter values required by the resource action associated with this action.
• ActionParameter7: string
  Maximum Length: 2048

  The seventh field for storing action parameter values required by the resource action associated with this action.
• ActionParameter8: string
  Maximum Length: 2048

  The eighth field for storing action parameter values required by the resource action associated with this action.
• ActionParameter9: string
  Maximum Length: 2048

  The ninth field for storing action parameter values required by the resource action associated with this action.
• ActionParameters: string (byte)
  Title: Action Parameters

  A field for storing action parameter values required by the resource action associated with this action.
• ActionSequence: integer (int32)
  Title: Action Sequence

  The sequence number for this action. Actions for a given rule are processed in order according to their sequence numbers.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• ModuleId: string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "type":"object",
    "properties":{
        "ActionSequence":{
            "title":"Action Sequence",
            "type":"integer",
            "description":"The sequence number for this action. Actions for a given rule are processed in order according to their sequence numbers.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            }
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "precision":"1"
            }
        },
        "ActionCode":{
            "maxLength":"32",
            "type":"string",
            "description":"The unique identifier of the resource action associated with this condition.",
            "nullable":false
        },
        "ActionParameter2":{
            "maxLength":"2048",
            "type":"string",
            "description":"The second field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true
        },
        "ActionParameter1":{
            "maxLength":"2048",
            "type":"string",
            "description":"The first field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true
        },
        "ActionParameter8":{
            "maxLength":"2048",
            "type":"string",
            "description":"The eighth field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true
        },
        "ActionParameter7":{
            "maxLength":"2048",
            "type":"string",
            "description":"The seventh field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.",
            "nullable":true
        },
        "ActionParameter9":{
            "maxLength":"2048",
            "type":"string",
            "description":"The ninth field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true
        },
        "ActionParameter4":{
            "maxLength":"2048",
            "type":"string",
            "description":"The fourth field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true
        },
        "ActionParameter3":{
            "maxLength":"2048",
            "type":"string",
            "description":"The third field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true
        },
        "ActionParameters":{
            "title":"Action Parameters",
            "type":"string",
            "description":"A field for storing action parameter values required by the resource action associated with this action.",
            "format":"byte",
            "nullable":true
        },
        "ActionParameter6":{
            "maxLength":"2048",
            "type":"string",
            "description":"The sixth field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true
        },
        "ActionParameter5":{
            "maxLength":"2048",
            "type":"string",
            "description":"The fifth field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true,
            "default":false
        }
    }
}

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

Type: object

Show Source

• ActionCode: string
  Maximum Length: 32

  The unique identifier of the resource action associated with this condition.
• ActionId: integer (int64)
  Read Only: true

  The unique identifier for this action.
• ActionParameter1: string
  Maximum Length: 2048

  The first field for storing action parameter values required by the resource action associated with this action.
• ActionParameter2: string
  Maximum Length: 2048

  The second field for storing action parameter values required by the resource action associated with this action.
• ActionParameter3: string
  Maximum Length: 2048

  The third field for storing action parameter values required by the resource action associated with this action.
• ActionParameter4: string
  Maximum Length: 2048

  The fourth field for storing action parameter values required by the resource action associated with this action.
• ActionParameter5: string
  Maximum Length: 2048

  The fifth field for storing action parameter values required by the resource action associated with this action.
• ActionParameter6: string
  Maximum Length: 2048

  The sixth field for storing action parameter values required by the resource action associated with this action.
• ActionParameter7: string
  Maximum Length: 2048

  The seventh field for storing action parameter values required by the resource action associated with this action.
• ActionParameter8: string
  Maximum Length: 2048

  The eighth field for storing action parameter values required by the resource action associated with this action.
• ActionParameter9: string
  Maximum Length: 2048

  The ninth field for storing action parameter values required by the resource action associated with this action.
• ActionParameters: string (byte)
  Title: Action Parameters

  A field for storing action parameter values required by the resource action associated with this action.
• ActionSequence: integer (int32)
  Title: Action Sequence

  The sequence number for this action. Actions for a given rule are processed in order according to their sequence numbers.
• AgencyId: integer (int32)
  Title: Agency Id

  The unique identifier for the agency associated with this action.
• DeletedFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModuleId: string
  Maximum Length: 32

  The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.
• RuleId: integer (int64)
  The unique identifier of the rule associated with this condition.
• SeedDataLock: integer (int32)
  Default Value: 0

  Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency Id",
            "type":"integer",
            "description":"The unique identifier for the agency associated with this action.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "ActionSequence":{
            "title":"Action Sequence",
            "type":"integer",
            "description":"The sequence number for this action. Actions for a given rule are processed in order according to their sequence numbers.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"5"
            },
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"The unique identifier of the rule associated with this condition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"Indicates the level at which the seed data is locked. The value 0 indicates customer data. The value 1 means the fields are read-only. The value 2 means that only some fields can be updated.",
            "format":"int32",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"32",
            "type":"string",
            "description":"The unique identifier of the resource action associated with this condition.",
            "nullable":false,
            "x-queryable":true
        },
        "ActionParameter2":{
            "maxLength":"2048",
            "type":"string",
            "description":"The second field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionParameter1":{
            "maxLength":"2048",
            "type":"string",
            "description":"The first field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionParameter8":{
            "maxLength":"2048",
            "type":"string",
            "description":"The eighth field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionParameter7":{
            "maxLength":"2048",
            "type":"string",
            "description":"The seventh field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The module that owns the row. A module is an entry in the application taxonomy, such as a logical business area. When no module is identified, then the seed data framework does not extract the row as seed data.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionId":{
            "type":"integer",
            "description":"The unique identifier for this action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ActionParameter9":{
            "maxLength":"2048",
            "type":"string",
            "description":"The ninth field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionParameter4":{
            "maxLength":"2048",
            "type":"string",
            "description":"The fourth field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionParameter3":{
            "maxLength":"2048",
            "type":"string",
            "description":"The third field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionParameters":{
            "title":"Action Parameters",
            "type":"string",
            "description":"A field for storing action parameter values required by the resource action associated with this action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "ActionParameter6":{
            "maxLength":"2048",
            "type":"string",
            "description":"The sixth field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionParameter5":{
            "maxLength":"2048",
            "type":"string",
            "description":"The fifth field for storing action parameter values required by the resource action associated with this action.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the seed data is logically deleted. If the value is Y, the seed data has been deleted. The default value is N.",
            "nullable":true,
            "default":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."
        }
    }
}

Back to Top