Create an award project reference
post
/fscmRestApi/resources/11.13.18.05/awards/{AwardId}/child/AwardProject/{AwardProjectId}/child/AwardProjectReference
Request
Path Parameters
-
AwardId(required): integer(int64)
Unique identifier of the award.
-
AwardProjectId(required): integer(int64)
Unique identifier of the award project.
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
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. -
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.
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.
Root Schema : awards-AwardProject-AwardProjectReference-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.