Jump to

• Request
• Response

Update an award department credit

patch

/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardDepartmentCredit/{AwardOrganizationCreditId}

Request

Path Parameters

• AwardId(required): integer(int64)
  Unique identifier of the award.
• AwardOrganizationCreditId(required): integer(int64)
  The unique Identifier of Award Organization Credit.

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 internal identifier of the award.
• AwardOrganizationCreditId: integer (int64)
  Title: Award Organization Credit

  The unique Identifier of Award Organization Credit.
• CreditPercentage: number
  Title: Organization Credit Percentage

  The credit percentage value of Award Organization Credit.
• OrganizationId: integer (int64)
  Title: Organization ID

  The unique internal identifier of the Organization.
• OrganizationName: string
  Title: Organization

  Maximum Length: 240

  The name of the Organization.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the Organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AwardOrganizationCreditId":{
            "title":"Award Organization Credit",
            "type":"integer",
            "description":"The unique Identifier of Award Organization Credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"The unique internal identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The unique internal identifier of the Organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreditPercentage":{
            "title":"Organization Credit Percentage",
            "type":"number",
            "description":"The credit percentage value of Award Organization Credit.",
            "nullable":false,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            }
        }
    }
}

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-AwardDepartmentCredit-item-response

Type: object

Show Source

• AwardId: integer (int64)
  Title: Award ID

  The unique internal identifier of the award.
• AwardOrganizationCreditId: integer (int64)
  Title: Award Organization Credit

  The unique Identifier of Award Organization Credit.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the award department credit was created.
• CreditPercentage: number
  Title: Organization Credit Percentage

  The credit percentage value of Award Organization Credit.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Title: Organization ID

  The unique internal identifier of the Organization.
• OrganizationName: string
  Title: Organization

  Maximum Length: 240

  The name of the Organization.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the award department credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the Organization.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the award department credit was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardOrganizationCreditId":{
            "title":"Award Organization Credit",
            "type":"integer",
            "description":"The unique Identifier of Award Organization Credit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the award department credit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"The unique internal identifier of the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"The unique internal identifier of the Organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditPercentage":{
            "title":"Organization Credit Percentage",
            "type":"number",
            "description":"The credit percentage value of Award Organization Credit.",
            "nullable":false,
            "x-hints":{
                "precision":"5",
                "scale":"2"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the award department 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