Jump to

• Request
• Response
• Examples

Create all federal attribute supplemental rule exception messages

post

/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/{SupplRuleHeaderId}/child/fedAttributeSupplementalRuleLines/{SupplRuleLineId}/child/fedAttributeSupplementalRuleExceptionMessages

Request

Path Parameters

• SupplRuleHeaderId(required): integer(int64)
  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=
• SupplRuleLineId(required): integer(int64)
  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=

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

• Code: string
  Title: Exception Code

  Maximum Length: 30

  Code of the federal attribute supplemental rule exception message.
• Description: string
  Title: Exception Text

  Maximum Length: 4000

  Description of the federal attribute supplemental rule exception message.
• ExceptionUniqueId: integer (int64)
  Title: Exception Unique Id

  The unique identifier of the federal attribute supplemental rule exception message.
• JobId: integer (int64)
  Title: Job Id

  The unique identifier of the job associated with the federal attribute supplemental rule exception message.
• ParentTableUniqueId: integer
  Title: Parent Table Unique Id

  The unique identifier of the parent table associated with the federal attribute supplemental rule exception message.
• ProcessName: string
  Title: Process Name

  Maximum Length: 150

  Name of the process associated with the federal attribute supplemental rule exception message.

{
    "type":"object",
    "properties":{
        "ParentTableUniqueId":{
            "title":"Parent Table Unique Id",
            "type":"integer",
            "description":"The unique identifier of the parent table associated with the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "maxLength":150,
            "type":"string",
            "description":"Name of the process associated with the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "Description":{
            "title":"Exception Text",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ExceptionUniqueId":{
            "title":"Exception Unique Id",
            "type":"integer",
            "description":"The unique identifier of the federal attribute supplemental rule exception message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            }
        },
        "Code":{
            "title":"Exception Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "JobId":{
            "title":"Job Id",
            "type":"integer",
            "description":"The unique identifier of the job associated with the federal attribute supplemental rule exception message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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 : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-response

Type: object

Show Source

• Code: string
  Title: Exception Code

  Maximum Length: 30

  Code of the federal attribute supplemental rule exception message.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the record was created.
• Description: string
  Title: Exception Text

  Maximum Length: 4000

  Description of the federal attribute supplemental rule exception message.
• ExceptionUniqueId: integer (int64)
  Title: Exception Unique Id

  The unique identifier of the federal attribute supplemental rule exception message.
• JobId: integer (int64)
  Title: Job Id

  The unique identifier of the job associated with the federal attribute supplemental rule exception message.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParentTableUniqueId: integer
  Title: Parent Table Unique Id

  The unique identifier of the parent table associated with the federal attribute supplemental rule exception message.
• ProcessName: string
  Title: Process Name

  Maximum Length: 150

  Name of the process associated with the federal attribute supplemental rule exception message.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ParentTableUniqueId":{
            "title":"Parent Table Unique Id",
            "type":"integer",
            "description":"The unique identifier of the parent table associated with the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ProcessName":{
            "title":"Process Name",
            "maxLength":150,
            "type":"string",
            "description":"Name of the process associated with the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Exception Text",
            "maxLength":4000,
            "type":"string",
            "description":"Description of the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ExceptionUniqueId":{
            "title":"Exception Unique Id",
            "type":"integer",
            "description":"The unique identifier of the federal attribute supplemental rule exception message.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Code":{
            "title":"Exception Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the federal attribute supplemental rule exception message.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "JobId":{
            "title":"Job Id",
            "type":"integer",
            "description":"The unique identifier of the job associated with the federal attribute supplemental rule exception message.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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

Examples

The following example shows how to create all federal attribute supplemental rule exception messages by submitting a POST request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-Type: application/json" -X POST https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/{SupplRuleHeaderId}/child/fedAttributeSupplementalRuleLines/{SupplRuleLineId}/child/fedAttributeSupplementalRuleExceptionMessage

Request Body Example

The following shows an example of the request body in JSON format.

{
    "Code": "OVERLAPPINGLINES",
    "Description": "The segment values overlap with supplemental rule line 300100586352373.",
    "ParentTableUniqueId": 300100586585110,
    "ProcessName": "Validate overlapping lines",
    "JobId": 300100586097657
}

Response Body Example

The following shows an example of the response body in JSON format.

{
	"ExceptionUniqueId": 100104052977057,
	"Code": "OVERLAPPINGLINES",
	"Description": "The segment values overlap with supplemental rule line 300100586352373.",
	"ParentTableUniqueId": 300100586585110,
	"ProcessName": "Validate overlapping lines",
	"JobId": 300100586097657,
	"CreatedBy": "username",
	"CreationDate": "2023-11-15T15:04:29+00:00",
	"LastUpdateDate": "2023-11-15T15:04:29+00:00",
	"LastUpdatedBy": "username",
	"links": [
		{
			"rel": "self",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100586097657/child/fedAttributeSupplementalRuleLines/300100586585110/child/fedAttributeSupplementalRuleExceptionMessages/100104052977057",
			"name": "fedAttributeSupplementalRuleExceptionMessages",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100586097657/child/fedAttributeSupplementalRuleLines/300100586585110/child/fedAttributeSupplementalRuleExceptionMessages/100104052977057",
			"name": "fedAttributeSupplementalRuleExceptionMessages",
			"kind": "item"
		},
		{
			"rel": "parent",
			"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100586097657/child/fedAttributeSupplementalRuleLines/300100586585110",
			"name": "fedAttributeSupplementalRuleLines",
			"kind": "item"
		}
	]
}

Back to Top