Jump to

• Request
• Response

Update an award term

patch

/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardTerms/{AwardTermsId}

Request

Path Parameters

• AwardId(required): integer(int64)
  Unique identifier of the award.
• AwardTermsId(required): integer(int64)
  The unique identifier of Award Terms and Conditions.

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

• AwardId: integer (int64)
  Title: Award ID

  The unique identifier of Award.
• AwardTermsId: integer (int64)
  The unique identifier of Award Terms and Conditions.
• Description: string
  Title: Description

  Maximum Length: 240

  Award Terms and Conditions description.
• TermsCategoryId: integer (int64)
  The unique identifier of Term and Conditions Category.
• TermsCategoryName: string
  Title: Terms and Conditions Category

  Maximum Length: 80

  The terms and Conditions Category name.
• TermsId: integer (int64)
  Title: Term ID

  Unique identifier of Terms and Conditions.
• TermsName: string
  Title: Terms and Conditions Name

  Maximum Length: 80

  Terms and Conditions Name.
• TermsOperator: string
  Title: Operator

  Maximum Length: 40

  Terms and Conditions Operator.
• TermsValue: string
  Title: Value

  Maximum Length: 20

  Terms and Conditions Term value.

{
    "type":"object",
    "properties":{
        "TermsCategoryId":{
            "type":"integer",
            "description":"The unique identifier of Term and Conditions Category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Award Terms and Conditions description.",
            "nullable":true
        },
        "TermsValue":{
            "title":"Value",
            "maxLength":"20",
            "type":"string",
            "description":"Terms and Conditions Term value.",
            "nullable":true
        },
        "TermsOperator":{
            "title":"Operator",
            "maxLength":"40",
            "type":"string",
            "description":"Terms and Conditions Operator.",
            "nullable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"The unique identifier of Award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TermsCategoryName":{
            "title":"Terms and Conditions Category",
            "maxLength":"80",
            "type":"string",
            "description":"The terms and Conditions Category name.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "TermsName":{
            "title":"Terms and Conditions Name",
            "maxLength":"80",
            "type":"string",
            "description":"Terms and Conditions Name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "TermsCategoryId"
                ]
            }
        },
        "TermsId":{
            "title":"Term ID",
            "type":"integer",
            "description":"Unique identifier of Terms and Conditions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "TermsCategoryId"
                ]
            }
        },
        "AwardTermsId":{
            "type":"integer",
            "description":"The unique identifier of Award Terms and Conditions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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 : awards-AwardTerms-item-response

Type: object

Show Source

• AwardId: integer (int64)
  Title: Award ID

  The unique identifier of Award.
• AwardTermsId: integer (int64)
  The unique identifier of Award Terms and Conditions.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that created the award terms.
• CreationDate: string (date-time)
  Read Only: true

  The date when the award terms was created.
• Description: string
  Title: Description

  Maximum Length: 240

  Award Terms and Conditions description.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the award term was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user that last updated the award terms.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TermsCategoryId: integer (int64)
  The unique identifier of Term and Conditions Category.
• TermsCategoryName: string
  Title: Terms and Conditions Category

  Maximum Length: 80

  The terms and Conditions Category name.
• TermsId: integer (int64)
  Title: Term ID

  Unique identifier of Terms and Conditions.
• TermsName: string
  Title: Terms and Conditions Name

  Maximum Length: 80

  Terms and Conditions Name.
• TermsOperator: string
  Title: Operator

  Maximum Length: 40

  Terms and Conditions Operator.
• TermsValue: string
  Title: Value

  Maximum Length: 20

  Terms and Conditions Term value.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the award terms.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the award terms was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the award terms.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Award Terms and Conditions description.",
            "nullable":true,
            "x-queryable":true
        },
        "TermsValue":{
            "title":"Value",
            "maxLength":"20",
            "type":"string",
            "description":"Terms and Conditions Term value.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"The unique identifier of Award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TermsCategoryName":{
            "title":"Terms and Conditions Category",
            "maxLength":"80",
            "type":"string",
            "description":"The terms and Conditions Category name.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "AwardTermsId":{
            "type":"integer",
            "description":"The unique identifier of Award Terms and Conditions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "TermsCategoryId":{
            "type":"integer",
            "description":"The unique identifier of Term and Conditions Category.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TermsOperator":{
            "title":"Operator",
            "maxLength":"40",
            "type":"string",
            "description":"Terms and Conditions Operator.",
            "nullable":true,
            "x-queryable":true
        },
        "TermsName":{
            "title":"Terms and Conditions Name",
            "maxLength":"80",
            "type":"string",
            "description":"Terms and Conditions Name.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "TermsCategoryId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TermsId":{
            "title":"Term ID",
            "type":"integer",
            "description":"Unique identifier of Terms and Conditions.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "dependencies":[
                    "TermsCategoryId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the award term 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