Jump to

• Request
• Response

Update an award project reference

patch

/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectReference/{AwardProjectReferenceId}

Request

Path Parameters

• AwardId(required): integer(int64)
  Unique identifier of the award.
• AwardProjectId(required): integer(int64)
  Unique identifier of the award project.
• AwardProjectReferenceId(required): integer(int64)
  Unique identifier of the reference type assigned to the award.

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

• ReferenceComment: string
  Title: Comments

  Maximum Length: 4000

  Comments for the reference type or value assigned to the award.
• ReferenceId: integer (int64)
  Title: Reference ID

  Unique identifier of the reference type.
• ReferenceTypeName: string
  Title: Reference Type Name

  Maximum Length: 80

  Name of the reference type assigned to an award project for identification purposes. For example, Proposal Number.
• ReferenceValue: string
  Title: Value

  Maximum Length: 300

  Value of the reference type, for example, the related proposal number.

{
    "type":"object",
    "properties":{
        "ReferenceTypeName":{
            "title":"Reference Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the reference type assigned to an award project for identification purposes. For example, Proposal Number.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"Unique identifier of the reference type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "ReferenceValue":{
            "title":"Value",
            "maxLength":"300",
            "type":"string",
            "description":"Value of the reference type, for example, the related proposal number.",
            "nullable":true
        },
        "ReferenceComment":{
            "title":"Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"Comments for the reference type or value assigned to the award.",
            "nullable":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-AwardProject-AwardProjectReference-item-response

Type: object

Show Source

• AwardId: integer (int64)
  Title: Award ID

  Unique identifier of the award.
• AwardProjectReferenceId: integer (int64)
  Title: Award Project Reference ID

  Unique identifier of the reference type assigned to the award.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

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

  Read Only: true

  Maximum Length: 240

  Description of the reference type assigned to an award project.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  The link relations associated with the resource instance.
• ReferenceComment: string
  Title: Comments

  Maximum Length: 4000

  Comments for the reference type or value assigned to the award.
• ReferenceId: integer (int64)
  Title: Reference ID

  Unique identifier of the reference type.
• ReferenceTypeName: string
  Title: Reference Type Name

  Maximum Length: 80

  Name of the reference type assigned to an award project for identification purposes. For example, Proposal Number.
• ReferenceValue: string
  Title: Value

  Maximum Length: 300

  Value of the reference type, for example, the related proposal number.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that last updated the award project reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the award project reference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AwardProjectReferenceId":{
            "title":"Award Project Reference ID",
            "type":"integer",
            "description":"Unique identifier of the reference type assigned to the award.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the reference type assigned to an award project.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user that created the award project reference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceTypeName":{
            "title":"Reference Type Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the reference type assigned to an award project for identification purposes. For example, Proposal Number.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ReferenceId":{
            "title":"Reference ID",
            "type":"integer",
            "description":"Unique identifier of the reference type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReferenceValue":{
            "title":"Value",
            "maxLength":"300",
            "type":"string",
            "description":"Value of the reference type, for example, the related proposal number.",
            "nullable":true,
            "x-queryable":true
        },
        "AwardId":{
            "title":"Award ID",
            "type":"integer",
            "description":"Unique 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"
            }
        },
        "ReferenceComment":{
            "title":"Comments",
            "maxLength":"4000",
            "type":"string",
            "description":"Comments for the reference type or value assigned to the award.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the award project reference 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