Jump to

• Request
• Response

Create an associated project

post

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/AssociatedProject

Request

Path Parameters

• LineId(required): integer(int64)
  The unique identifier of the contract line.
• contractsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Flag to check if linkage is still valid
• CurrencyCode: string
  Title: Contract Currency

  The currency code.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Reference key in External source
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  External Source Key
• FundingAmount: number
  Title: Contract Funding

  Linkage funding amount
• LinkId: integer (int64)
  Title: Contract Project Association ID

  The unique identifier of the Contract project linkage.
• MajorVersion: integer (int64)
  Title: Version

  Contract Version on which linkage is defined
• PercentComplete: number
  Title: Percent Complete

  Percentage Complete
• ProjectId: integer (int64)
  Title: Project ID

  Project Identifier for the project on Linkage
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Project Number of the project on Linkage
• ProjElementId: integer (int64)
  Title: Project Task ID

  Task Identifier for the the task on linkage
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Task Number of the Task on the linkage

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to check if linkage is still valid",
            "nullable":false,
            "default":true
        },
        "CurrencyCode":{
            "title":"Contract Currency",
            "type":"string",
            "description":"The currency code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"Reference key in External source",
            "nullable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"External Source Key",
            "nullable":true
        },
        "FundingAmount":{
            "title":"Contract Funding",
            "type":"number",
            "description":"Linkage funding amount",
            "nullable":true
        },
        "LinkId":{
            "title":"Contract Project Association ID",
            "type":"integer",
            "description":"The unique identifier of the Contract project linkage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Contract Version on which linkage is defined",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PercentComplete":{
            "title":"Percent Complete",
            "type":"number",
            "description":"Percentage Complete",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":2
            }
        },
        "ProjElementId":{
            "title":"Project Task ID",
            "type":"integer",
            "description":"Task Identifier for the the task on linkage",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ProjectId",
                    "ProjectNumber"
                ]
            }
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Project Identifier for the project on Linkage",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"Project Number of the project on Linkage",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ProjectId"
                ]
            }
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"Task Number of the Task on the linkage",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ProjectId",
                    "ProjectNumber"
                ]
            }
        }
    }
}

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 : contracts-ContractLine-AssociatedProject-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Maximum Length: 1

  Default Value: true

  Flag to check if linkage is still valid
• CurrencyCode: string
  Title: Contract Currency

  The currency code.
• ExternalReferenceKey: string
  Title: External Reference Key

  Maximum Length: 150

  Reference key in External source
• ExternalSourceKey: string
  Title: External Source Key

  Maximum Length: 150

  External Source Key
• FundingAmount: number
  Title: Contract Funding

  Linkage funding amount
• LastRevRecogDate: string (date)
  Title: Last Revenue Recognized Date

  Read Only: true

  The date revenue was last recognized for this associated project within this contract line.
• LinkId: integer (int64)
  Title: Contract Project Association ID

  The unique identifier of the Contract project linkage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MajorVersion: integer (int64)
  Title: Version

  Contract Version on which linkage is defined
• PercentComplete: number
  Title: Percent Complete

  Percentage Complete
• ProjectId: integer (int64)
  Title: Project ID

  Project Identifier for the project on Linkage
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 25

  Project Number of the project on Linkage
• ProjElementId: integer (int64)
  Title: Project Task ID

  Task Identifier for the the task on linkage
• TaskNumber: string
  Title: Task Number

  Maximum Length: 100

  Task Number of the Task on the linkage

{
    "type":"object",
    "properties":{
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to check if linkage is still valid",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Contract Currency",
            "type":"string",
            "description":"The currency code.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ExternalReferenceKey":{
            "title":"External Reference Key",
            "maxLength":150,
            "type":"string",
            "description":"Reference key in External source",
            "nullable":true,
            "x-queryable":true
        },
        "ExternalSourceKey":{
            "title":"External Source Key",
            "maxLength":150,
            "type":"string",
            "description":"External Source Key",
            "nullable":true,
            "x-queryable":true
        },
        "FundingAmount":{
            "title":"Contract Funding",
            "type":"number",
            "description":"Linkage funding amount",
            "nullable":true,
            "x-queryable":true
        },
        "LastRevRecogDate":{
            "title":"Last Revenue Recognized Date",
            "type":"string",
            "description":"The date revenue was last recognized for this associated project within this contract line.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LinkId":{
            "title":"Contract Project Association ID",
            "type":"integer",
            "description":"The unique identifier of the Contract project linkage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MajorVersion":{
            "title":"Version",
            "type":"integer",
            "description":"Contract Version on which linkage is defined",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PercentComplete":{
            "title":"Percent Complete",
            "type":"number",
            "description":"Percentage Complete",
            "nullable":true,
            "x-hints":{
                "precision":5,
                "scale":2
            },
            "x-queryable":true
        },
        "ProjElementId":{
            "title":"Project Task ID",
            "type":"integer",
            "description":"Task Identifier for the the task on linkage",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ProjectId",
                    "ProjectNumber"
                ]
            },
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Project Identifier for the project on Linkage",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":25,
            "type":"string",
            "description":"Project Number of the project on Linkage",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ProjectId"
                ]
            },
            "x-queryable":true
        },
        "TaskNumber":{
            "title":"Task Number",
            "maxLength":100,
            "type":"string",
            "description":"Task Number of the Task on the linkage",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "ProjectId",
                    "ProjectNumber"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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