Jump to

• Request
• Response

Create an action

post

/fscmRestApi/resources/11.13.18.05/publicSectorBusinessRulesFrameworkActions

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

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

Root Schema : publicSectorBusinessRulesFrameworkActions-item

Type: object

Show Source

• ActionCode(optional): string
  Maximum Length: 32

  The unique identifier of the resource action associated with this condition.
• ActionId(optional): integer(int64)
  The unique identifier for this action.
• ActionParameter1(optional): string
  Maximum Length: 256

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

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

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

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

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

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

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

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

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

  A field for storing action parameter values required by the resource action associated with this action.
• ActionSequence(optional): 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(optional): integer(int32)
  Title: Agency Id

  The unique identifier for the agency associated with this action.
• DeletedFlag(optional): string
  Maximum Length: 1

  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(optional): array Items
  Title: Items

  Link Relations
• ModuleId(optional): 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(optional): integer(int64)
  The unique identifier of the rule associated with this condition.
• SeedDataLock(optional): integer(int32)
  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.

{
    "properties":{
        "ActionCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the resource action associated with this condition."
        },
        "ActionId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for this action."
        },
        "ActionParameter1":{
            "maxLength":256,
            "type":"string",
            "description":"The first field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter2":{
            "maxLength":256,
            "type":"string",
            "description":"The second field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter3":{
            "maxLength":256,
            "type":"string",
            "description":"The third field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter4":{
            "maxLength":256,
            "type":"string",
            "description":"The fourth field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter5":{
            "maxLength":256,
            "type":"string",
            "description":"The fifth field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter6":{
            "maxLength":256,
            "type":"string",
            "description":"The sixth field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter7":{
            "maxLength":256,
            "type":"string",
            "description":"The seventh field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter8":{
            "maxLength":256,
            "type":"string",
            "description":"The eighth field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter9":{
            "maxLength":256,
            "type":"string",
            "description":"The ninth field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameters":{
            "type":"string",
            "description":"A field for storing action parameter values required by the resource action associated with this action.",
            "title":"Action Parameters"
        },
        "ActionSequence":{
            "format":"int32",
            "type":"integer",
            "description":"The sequence number for this action. Actions for a given rule are processed in order according to their sequence numbers.",
            "title":"Action Sequence"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency associated with this action.",
            "title":"Agency Id"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "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."
        },
        "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."
        },
        "RuleId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the rule associated with this condition."
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorBusinessRulesFrameworkActions-item

Type: object

Show Source

• ActionCode(optional): string
  Maximum Length: 32

  The unique identifier of the resource action associated with this condition.
• ActionId(optional): integer(int64)
  The unique identifier for this action.
• ActionParameter1(optional): string
  Maximum Length: 256

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

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

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

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

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

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

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

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

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

  A field for storing action parameter values required by the resource action associated with this action.
• ActionSequence(optional): 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(optional): integer(int32)
  Title: Agency Id

  The unique identifier for the agency associated with this action.
• DeletedFlag(optional): string
  Maximum Length: 1

  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(optional): array Items
  Title: Items

  Link Relations
• ModuleId(optional): 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(optional): integer(int64)
  The unique identifier of the rule associated with this condition.
• SeedDataLock(optional): integer(int32)
  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.

{
    "properties":{
        "ActionCode":{
            "maxLength":32,
            "type":"string",
            "description":"The unique identifier of the resource action associated with this condition."
        },
        "ActionId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier for this action."
        },
        "ActionParameter1":{
            "maxLength":256,
            "type":"string",
            "description":"The first field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter2":{
            "maxLength":256,
            "type":"string",
            "description":"The second field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter3":{
            "maxLength":256,
            "type":"string",
            "description":"The third field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter4":{
            "maxLength":256,
            "type":"string",
            "description":"The fourth field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter5":{
            "maxLength":256,
            "type":"string",
            "description":"The fifth field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter6":{
            "maxLength":256,
            "type":"string",
            "description":"The sixth field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter7":{
            "maxLength":256,
            "type":"string",
            "description":"The seventh field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter8":{
            "maxLength":256,
            "type":"string",
            "description":"The eighth field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameter9":{
            "maxLength":256,
            "type":"string",
            "description":"The ninth field for storing action parameter values required by the resource action associated with this action."
        },
        "ActionParameters":{
            "type":"string",
            "description":"A field for storing action parameter values required by the resource action associated with this action.",
            "title":"Action Parameters"
        },
        "ActionSequence":{
            "format":"int32",
            "type":"integer",
            "description":"The sequence number for this action. Actions for a given rule are processed in order according to their sequence numbers.",
            "title":"Action Sequence"
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier for the agency associated with this action.",
            "title":"Agency Id"
        },
        "DeletedFlag":{
            "maxLength":1,
            "type":"string",
            "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."
        },
        "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."
        },
        "RuleId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the rule associated with this condition."
        },
        "SeedDataLock":{
            "format":"int32",
            "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."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

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

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top