Jump to

• Request
• Response

Get many schedule of values versions

get

/fscmRestApi/resources/11.13.18.05/sovVersions

Request

Query Parameters

• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds a schedule of values version using the primary key.
    Finder Variables
    • SovVersionId; integer; The primary key for schedule of values versions.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AttributeCategory; string; Schedule of values descriptive flexfield context.
  • AttributeChar1; string; Schedule of values descriptive flexfield character attribute 1.
  • AttributeChar10; string; Schedule of values descriptive flexfield character attribute 10.
  • AttributeChar2; string; Schedule of values descriptive flexfield character attribute 2.
  • AttributeChar3; string; Schedule of values descriptive flexfield character attribute 3.
  • AttributeChar4; string; Schedule of values descriptive flexfield character attribute 4.
  • AttributeChar5; string; Schedule of values descriptive flexfield character attribute 5.
  • AttributeChar6; string; Schedule of values descriptive flexfield character attribute 6.
  • AttributeChar7; string; Schedule of values descriptive flexfield character attribute 7.
  • AttributeChar8; string; Schedule of values descriptive flexfield character attribute 8.
  • AttributeChar9; string; Schedule of values descriptive flexfield character attribute 9.
  • AttributeDate1; string; Schedule of values descriptive flexfield date attribute 1.
  • AttributeDate2; string; Schedule of values descriptive flexfield date attribute 2.
  • AttributeDate3; string; Schedule of values descriptive flexfield date attribute 3.
  • AttributeDate4; string; Schedule of values descriptive flexfield date attribute 4.
  • AttributeDate5; string; Schedule of values descriptive flexfield date attribute 5.
  • AttributeNumber1; number; Schedule of values descriptive flexfield number attribute 1.
  • AttributeNumber10; number; Schedule of values descriptive flexfield number attribute 10.
  • AttributeNumber2; number; Schedule of values descriptive flexfield number attribute 2.
  • AttributeNumber3; number; Schedule of values descriptive flexfield number attribute 3.
  • AttributeNumber4; number; Schedule of values descriptive flexfield number attribute 4.
  • AttributeNumber5; number; Schedule of values descriptive flexfield number attribute 5.
  • AttributeNumber6; number; Schedule of values descriptive flexfield number attribute 6.
  • AttributeNumber7; number; Schedule of values descriptive flexfield number attribute 7.
  • AttributeNumber8; number; Schedule of values descriptive flexfield number attribute 8.
  • AttributeNumber9; number; Schedule of values descriptive flexfield number attribute 9.
  • ContractId; integer; Unique identifier for the contract currently associated with the schedule of values version, identified by an active project association.
  • ContractNumber; string; Number of the contract currently associated with the schedule of values version, identified by an active project association.
  • CreatedBy; string; User who created the schedule of values version.
  • CreationDate; string; Date and time when the schedule of values version was created.
  • CurrencyCode; string; Currency code of a schedule of values version, which is always equal to the contract currency.
  • FundsAvailable; number; Variance between the total contract funded amount and the total schedule of values amount.
  • ItemValidationOrgId; number; Unique identifier for the item validation organization used to validate items assigned to schedule of values lines. The item validation organization is defined in the Receivables System Options for the Project Business Unit.
  • LastUpdateDate; string; Date and time when the schedule of values version was last updated.
  • LastUpdatedBy; string; User who last updated the schedule of values line.
  • ProjectId; integer; Unique identifier for the project associated with the schedule of values version.
  • ProjectName; string; Name of the project to which the schedule of values version is associated.
  • ProjectNumber; string; Number of the project to which the schedule of values version is associated.
  • SovVersionId; integer; Unique identifier for a schedule of values version.
  • Status; string; Status of a schedule of values version.
  • StatusCode; string; Nontranslated short code that indicates the status of a schedule of values version.
  • TotalAmount; number; Total of all line amounts associated with the schedule of values version in contract currency.
  • TotalFundedAmount; number; Total contract funded amount in contract currency.
  • TotalPlannedAmount; number; Total amount planned in the financial project plan in contract currency.
  • VersionDescription; string; Description of a schedule of values.
  • VersionNumber; integer; Sequential version number of a schedule of values.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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 : sovVersions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/sovVersions-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object sovVersions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/sovVersions-item-response"
    }
}

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 : sovVersions-item-response

Type: object

Show Source

• AttributeCategory: string
  Title: Descriptive Flexfield Context

  Maximum Length: 30

  Schedule of values descriptive flexfield context.
• AttributeChar1: string
  Title: Character Attribute 1

  Maximum Length: 240

  Schedule of values descriptive flexfield character attribute 1.
• AttributeChar10: string
  Title: Character Attribute 10

  Maximum Length: 240

  Schedule of values descriptive flexfield character attribute 10.
• AttributeChar2: string
  Title: Character Attribute 2

  Maximum Length: 240

  Schedule of values descriptive flexfield character attribute 2.
• AttributeChar3: string
  Title: Character Attribute 3

  Maximum Length: 240

  Schedule of values descriptive flexfield character attribute 3.
• AttributeChar4: string
  Title: Character Attribute 4

  Maximum Length: 240

  Schedule of values descriptive flexfield character attribute 4.
• AttributeChar5: string
  Title: Character Attribute 5

  Maximum Length: 240

  Schedule of values descriptive flexfield character attribute 5.
• AttributeChar6: string
  Title: Character Attribute 6

  Maximum Length: 240

  Schedule of values descriptive flexfield character attribute 6.
• AttributeChar7: string
  Title: Character Attribute 7

  Maximum Length: 240

  Schedule of values descriptive flexfield character attribute 7.
• AttributeChar8: string
  Title: Character Attribute 8

  Maximum Length: 240

  Schedule of values descriptive flexfield character attribute 8.
• AttributeChar9: string
  Title: Character Attribute 9

  Maximum Length: 240

  Schedule of values descriptive flexfield character attribute 9.
• AttributeDate1: string (date)
  Title: Date Attribute 1

  Schedule of values descriptive flexfield date attribute 1.
• AttributeDate2: string (date)
  Title: Date Attribute 2

  Schedule of values descriptive flexfield date attribute 2.
• AttributeDate3: string (date)
  Title: Date Attribute 3

  Schedule of values descriptive flexfield date attribute 3.
• AttributeDate4: string (date)
  Title: Date Attribute 4

  Schedule of values descriptive flexfield date attribute 4.
• AttributeDate5: string (date)
  Title: Date Attribute 5

  Schedule of values descriptive flexfield date attribute 5.
• AttributeNumber1: number
  Title: Number Attribute 1

  Schedule of values descriptive flexfield number attribute 1.
• AttributeNumber10: number
  Title: Number Attribute 10

  Schedule of values descriptive flexfield number attribute 10.
• AttributeNumber2: number
  Title: Number Attribute 2

  Schedule of values descriptive flexfield number attribute 2.
• AttributeNumber3: number
  Title: Number Attribute 3

  Schedule of values descriptive flexfield number attribute 3.
• AttributeNumber4: number
  Title: Number Attribute 4

  Schedule of values descriptive flexfield number attribute 4.
• AttributeNumber5: number
  Title: Number Attribute 5

  Schedule of values descriptive flexfield number attribute 5.
• AttributeNumber6: number
  Title: Number Attribute 6

  Schedule of values descriptive flexfield number attribute 6.
• AttributeNumber7: number
  Title: Number Attribute 7

  Schedule of values descriptive flexfield number attribute 7.
• AttributeNumber8: number
  Title: Number Attribute 8

  Schedule of values descriptive flexfield number attribute 8.
• AttributeNumber9: number
  Title: Number Attribute 9

  Schedule of values descriptive flexfield number attribute 9.
• ContractId: integer
  Title: Contract ID

  Read Only: true

  Unique identifier for the contract currently associated with the schedule of values version, identified by an active project association.
• ContractNumber: string
  Title: Contract Number

  Read Only: true

  Maximum Length: 240

  Number of the contract currently associated with the schedule of values version, identified by an active project association.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the schedule of values version.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the schedule of values version was created.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 15

  Currency code of a schedule of values version, which is always equal to the contract currency.
• FundsAvailable: number
  Title: Funds Available

  Read Only: true

  Variance between the total contract funded amount and the total schedule of values amount.
• ItemValidationOrgId: number
  Title: Item Validation Organization ID

  Read Only: true

  Unique identifier for the item validation organization used to validate items assigned to schedule of values lines. The item validation organization is defined in the Receivables System Options for the Project Business Unit.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the schedule of values version was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the schedule of values line.
• links: array Links
  Title: Links

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

  Unique identifier for the project associated with the schedule of values version.
• ProjectName: string
  Title: Project Name

  Maximum Length: 255

  Name of the project to which the schedule of values version is associated.
• ProjectNumber: string
  Title: Project Number

  Maximum Length: 255

  Number of the project to which the schedule of values version is associated.
• SovLines: array Schedule of Values Lines
  Title: Schedule of Values Lines

  The Schedule of Values Lines resource is used to view, update, delete, and take action on schedule of values lines. A schedule of values line represents a specific project deliverable which is primarily used to track progress against to drive billing.
• SovVersionId: integer (int64)
  Title: Schedule of Values Version ID

  Unique identifier for a schedule of values version.
• Status: string
  Title: Status

  Read Only: true

  Maximum Length: 255

  Status of a schedule of values version.
• StatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  Nontranslated short code that indicates the status of a schedule of values version.
• TotalAmount: number
  Title: Total Amount

  Read Only: true

  Total of all line amounts associated with the schedule of values version in contract currency.
• TotalFundedAmount: number
  Title: Total Funded Amount

  Read Only: true

  Total contract funded amount in contract currency.
• TotalPlannedAmount: number
  Title: Total Planned Amount

  Read Only: true

  Total amount planned in the financial project plan in contract currency.
• VersionDescription: string
  Title: Description

  Maximum Length: 2000

  Description of a schedule of values.
• VersionNumber: integer (int64)
  Title: Version

  Sequential version number of a schedule of values.

{
    "type":"object",
    "properties":{
        "AttributeCategory":{
            "title":"Descriptive Flexfield Context",
            "maxLength":30,
            "type":"string",
            "description":"Schedule of values descriptive flexfield context.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar1":{
            "title":"Character Attribute 1",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values descriptive flexfield character attribute 1.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar10":{
            "title":"Character Attribute 10",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values descriptive flexfield character attribute 10.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar2":{
            "title":"Character Attribute 2",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values descriptive flexfield character attribute 2.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar3":{
            "title":"Character Attribute 3",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values descriptive flexfield character attribute 3.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar4":{
            "title":"Character Attribute 4",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values descriptive flexfield character attribute 4.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar5":{
            "title":"Character Attribute 5",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values descriptive flexfield character attribute 5.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar6":{
            "title":"Character Attribute 6",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values descriptive flexfield character attribute 6.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar7":{
            "title":"Character Attribute 7",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values descriptive flexfield character attribute 7.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar8":{
            "title":"Character Attribute 8",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values descriptive flexfield character attribute 8.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar9":{
            "title":"Character Attribute 9",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values descriptive flexfield character attribute 9.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate1":{
            "title":"Date Attribute 1",
            "type":"string",
            "description":"Schedule of values descriptive flexfield date attribute 1.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate2":{
            "title":"Date Attribute 2",
            "type":"string",
            "description":"Schedule of values descriptive flexfield date attribute 2.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate3":{
            "title":"Date Attribute 3",
            "type":"string",
            "description":"Schedule of values descriptive flexfield date attribute 3.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate4":{
            "title":"Date Attribute 4",
            "type":"string",
            "description":"Schedule of values descriptive flexfield date attribute 4.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate5":{
            "title":"Date Attribute 5",
            "type":"string",
            "description":"Schedule of values descriptive flexfield date attribute 5.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber1":{
            "title":"Number Attribute 1",
            "type":"number",
            "description":"Schedule of values descriptive flexfield number attribute 1.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber10":{
            "title":"Number Attribute 10",
            "type":"number",
            "description":"Schedule of values descriptive flexfield number attribute 10.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber2":{
            "title":"Number Attribute 2",
            "type":"number",
            "description":"Schedule of values descriptive flexfield number attribute 2.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber3":{
            "title":"Number Attribute 3",
            "type":"number",
            "description":"Schedule of values descriptive flexfield number attribute 3.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber4":{
            "title":"Number Attribute 4",
            "type":"number",
            "description":"Schedule of values descriptive flexfield number attribute 4.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber5":{
            "title":"Number Attribute 5",
            "type":"number",
            "description":"Schedule of values descriptive flexfield number attribute 5.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber6":{
            "title":"Number Attribute 6",
            "type":"number",
            "description":"Schedule of values descriptive flexfield number attribute 6.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber7":{
            "title":"Number Attribute 7",
            "type":"number",
            "description":"Schedule of values descriptive flexfield number attribute 7.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber8":{
            "title":"Number Attribute 8",
            "type":"number",
            "description":"Schedule of values descriptive flexfield number attribute 8.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber9":{
            "title":"Number Attribute 9",
            "type":"number",
            "description":"Schedule of values descriptive flexfield number attribute 9.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractId":{
            "title":"Contract ID",
            "type":"integer",
            "description":"Unique identifier for the contract currently associated with the schedule of values version, identified by an active project association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractNumber":{
            "title":"Contract Number",
            "maxLength":240,
            "type":"string",
            "description":"Number of the contract currently associated with the schedule of values version, identified by an active project association.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the schedule of values version.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the schedule of values version was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"Currency code of a schedule of values version, which is always equal to the contract currency.",
            "nullable":false,
            "x-queryable":true
        },
        "FundsAvailable":{
            "title":"Funds Available",
            "type":"number",
            "description":"Variance between the total contract funded amount and the total schedule of values amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemValidationOrgId":{
            "title":"Item Validation Organization ID",
            "type":"number",
            "description":"Unique identifier for the item validation organization used to validate items assigned to schedule of values lines. The item validation organization is defined in the Receivables System Options for the Project Business Unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the schedule of values version was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the schedule of values line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProjectId":{
            "title":"Project ID",
            "type":"integer",
            "description":"Unique identifier for the project associated with the schedule of values version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProjectName":{
            "title":"Project Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the project to which the schedule of values version is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "ProjectNumber":{
            "title":"Project Number",
            "maxLength":255,
            "type":"string",
            "description":"Number of the project to which the schedule of values version is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "SovLines":{
            "title":"Schedule of Values Lines",
            "type":"array",
            "description":"The Schedule of Values Lines resource is used to view, update, delete, and take action on schedule of values lines. A schedule of values line represents a specific project deliverable which is primarily used to track progress against to drive billing.",
            "items":{
                "$ref":"#/components/schemas/sovVersions-SovLines-item-response"
            }
        },
        "SovVersionId":{
            "title":"Schedule of Values Version ID",
            "type":"integer",
            "description":"Unique identifier for a schedule of values version.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of a schedule of values version.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Nontranslated short code that indicates the status of a schedule of values version.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalAmount":{
            "title":"Total Amount",
            "type":"number",
            "description":"Total of all line amounts associated with the schedule of values version in contract currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFundedAmount":{
            "title":"Total Funded Amount",
            "type":"number",
            "description":"Total contract funded amount in contract currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPlannedAmount":{
            "title":"Total Planned Amount",
            "type":"number",
            "description":"Total amount planned in the financial project plan in contract currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VersionDescription":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of a schedule of values.",
            "nullable":true,
            "x-queryable":true
        },
        "VersionNumber":{
            "title":"Version",
            "type":"integer",
            "description":"Sequential version number of a schedule of values.",
            "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"
            }
        }
    }
}

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 : Schedule of Values Lines

Type: array

Title: Schedule of Values Lines

The Schedule of Values Lines resource is used to view, update, delete, and take action on schedule of values lines. A schedule of values line represents a specific project deliverable which is primarily used to track progress against to drive billing.

Show Source

• Array of: object sovVersions-SovLines-item-response

{
    "title":"Schedule of Values Lines",
    "type":"array",
    "description":"The Schedule of Values Lines resource is used to view, update, delete, and take action on schedule of values lines. A schedule of values line represents a specific project deliverable which is primarily used to track progress against to drive billing.",
    "items":{
        "$ref":"#/components/schemas/sovVersions-SovLines-item-response"
    }
}

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."
        }
    }
}

Nested Schema : sovVersions-SovLines-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  Amount of a schedule of values line in contract currency.
• AttributeCategory: string
  Title: Descriptive Flexfield Context

  Maximum Length: 30

  Schedule of values line descriptive flexfield context.
• AttributeChar1: string
  Title: Character Attribute 1

  Maximum Length: 240

  Schedule of values line descriptive flexfield character attribute 1.
• AttributeChar10: string
  Title: Character Attribute 10

  Maximum Length: 240

  Schedule of values line descriptive flexfield character attribute 10.
• AttributeChar2: string
  Title: Character Attribute 2

  Maximum Length: 240

  Schedule of values line descriptive flexfield character attribute 2.
• AttributeChar3: string
  Title: Character Attribute 3

  Maximum Length: 240

  Schedule of values line descriptive flexfield character attribute 3.
• AttributeChar4: string
  Title: Character Attribute 4

  Maximum Length: 240

  Schedule of values line descriptive flexfield character attribute 4.
• AttributeChar5: string
  Title: Character Attribute 5

  Maximum Length: 240

  Schedule of values line descriptive flexfield character attribute 5.
• AttributeChar6: string
  Title: Character Attribute 6

  Maximum Length: 240

  Schedule of values line descriptive flexfield character attribute 6.
• AttributeChar7: string
  Title: Character Attribute 7

  Maximum Length: 240

  Schedule of values line descriptive flexfield character attribute 7.
• AttributeChar8: string
  Title: Character Attribute 8

  Maximum Length: 240

  Schedule of values line descriptive flexfield character attribute 8.
• AttributeChar9: string
  Title: Character Attribute 9

  Maximum Length: 240

  Schedule of values line descriptive flexfield character attribute 9.
• AttributeDate1: string (date)
  Title: Date Attribute 1

  Schedule of values line descriptive flexfield date attribute 1.
• AttributeDate2: string (date)
  Title: Date Attribute 2

  Schedule of values line descriptive flexfield date attribute 2.
• AttributeDate3: string (date)
  Title: Date Attribute 3

  Schedule of values line descriptive flexfield date attribute 3.
• AttributeDate4: string (date)
  Title: Date Attribute 4

  Schedule of values line descriptive flexfield date attribute 4.
• AttributeDate5: string (date)
  Title: Date Attribute 5

  Schedule of values line descriptive flexfield date attribute 5.
• AttributeNumber1: number
  Title: Number Attribute 1

  Schedule of values line descriptive flexfield number attribute 1.
• AttributeNumber10: number
  Title: Number Attribute 10

  Schedule of values line descriptive flexfield number attribute 10.
• AttributeNumber2: number
  Title: Number Attribute 2

  Schedule of values line descriptive flexfield number attribute 2.
• AttributeNumber3: number
  Title: Number Attribute 3

  Schedule of values line descriptive flexfield number attribute 3.
• AttributeNumber4: number
  Title: Number Attribute 4

  Schedule of values line descriptive flexfield number attribute 4.
• AttributeNumber5: number
  Title: Number Attribute 5

  Schedule of values line descriptive flexfield number attribute 5.
• AttributeNumber6: number
  Title: Number Attribute 6

  Schedule of values line descriptive flexfield number attribute 6.
• AttributeNumber7: number
  Title: Number Attribute 7

  Schedule of values line descriptive flexfield number attribute 7.
• AttributeNumber8: number
  Title: Number Attribute 8

  Schedule of values line descriptive flexfield number attribute 8.
• AttributeNumber9: number
  Title: Number Attribute 9

  Schedule of values line descriptive flexfield number attribute 9.
• ChangeIndicator: string
  Title: Change Indicator

  Read Only: true

  Maximum Length: 255

  Indicates whether a line has been added or amended when the schedule of values is under revision.
• ChangeIndicatorCode: string
  Title: Change Indicator Code

  Maximum Length: 30

  Nontranslated short code that indicates whether a line has been added or amended when the schedule of values is under revision.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the line.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date and time when the line was created.
• InventoryItemId: integer (int64)
  Title: Item ID

  Unique identifier for the inventory item associated with the line.
• InventoryItemNumber: string
  Title: Item

  Maximum Length: 255

  Inventory item number associated with the line.
• ItemOrganizationId: integer (int64)
  Title: Item Organization ID

  Unique identifier for the inventory item organization associated with the line.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  Date and time when the line was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  User who last updated the line.
• LineDescription: string
  Title: Description

  Maximum Length: 2000

  Description of a schedule of values line.
• LineNumber: integer (int64)
  Title: Line

  Sequential line number that identifies a schedule of values line.
• LineStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 255

  Status of a schedule of values line.
• LineStatusCode: string
  Title: Status Code

  Read Only: true

  Maximum Length: 30

  Nontranslated short code that indicates the status of a schedule of values line.
• LineType: string
  Title: Type

  Maximum Length: 255

  Line type of a schedule of values line.
• LineTypeCode: string
  Title: Type Code

  Maximum Length: 30

  Nontranslated short code that indicates the line type of a schedule of values line.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Quantity: number
  Title: Quantity

  Quantity of a schedule of values line. Context for the quantity is provided by the unit of measure.
• SovLineId: integer (int64)
  Title: Line ID

  Unique identifier for a schedule of values line.
• SovVersionId: integer (int64)
  Title: Schedule of Values Version ID

  Unique identifier for the schedule of values version to which a line is associated.
• UnitOfMeasure: string
  Title: Unit of Measure

  Maximum Length: 255

  Unit of measure of a schedule of values line. Provides context to the quantity and unit price.
• UnitOfMeasureCode: string
  Title: Unit of Measure Code

  Maximum Length: 30

  Nontranslated short code that indicates the unit of measure of a schedule of values line.
• UnitPrice: number
  Title: Unit Price

  Unit price of a schedule of values line in contract currency.

{
    "type":"object",
    "properties":{
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"Amount of a schedule of values line in contract currency.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeCategory":{
            "title":"Descriptive Flexfield Context",
            "maxLength":30,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield context.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar1":{
            "title":"Character Attribute 1",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield character attribute 1.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar10":{
            "title":"Character Attribute 10",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield character attribute 10.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar2":{
            "title":"Character Attribute 2",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield character attribute 2.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar3":{
            "title":"Character Attribute 3",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield character attribute 3.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar4":{
            "title":"Character Attribute 4",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield character attribute 4.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar5":{
            "title":"Character Attribute 5",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield character attribute 5.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar6":{
            "title":"Character Attribute 6",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield character attribute 6.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar7":{
            "title":"Character Attribute 7",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield character attribute 7.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar8":{
            "title":"Character Attribute 8",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield character attribute 8.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeChar9":{
            "title":"Character Attribute 9",
            "maxLength":240,
            "type":"string",
            "description":"Schedule of values line descriptive flexfield character attribute 9.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate1":{
            "title":"Date Attribute 1",
            "type":"string",
            "description":"Schedule of values line descriptive flexfield date attribute 1.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate2":{
            "title":"Date Attribute 2",
            "type":"string",
            "description":"Schedule of values line descriptive flexfield date attribute 2.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate3":{
            "title":"Date Attribute 3",
            "type":"string",
            "description":"Schedule of values line descriptive flexfield date attribute 3.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate4":{
            "title":"Date Attribute 4",
            "type":"string",
            "description":"Schedule of values line descriptive flexfield date attribute 4.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeDate5":{
            "title":"Date Attribute 5",
            "type":"string",
            "description":"Schedule of values line descriptive flexfield date attribute 5.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber1":{
            "title":"Number Attribute 1",
            "type":"number",
            "description":"Schedule of values line descriptive flexfield number attribute 1.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber10":{
            "title":"Number Attribute 10",
            "type":"number",
            "description":"Schedule of values line descriptive flexfield number attribute 10.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber2":{
            "title":"Number Attribute 2",
            "type":"number",
            "description":"Schedule of values line descriptive flexfield number attribute 2.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber3":{
            "title":"Number Attribute 3",
            "type":"number",
            "description":"Schedule of values line descriptive flexfield number attribute 3.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber4":{
            "title":"Number Attribute 4",
            "type":"number",
            "description":"Schedule of values line descriptive flexfield number attribute 4.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber5":{
            "title":"Number Attribute 5",
            "type":"number",
            "description":"Schedule of values line descriptive flexfield number attribute 5.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber6":{
            "title":"Number Attribute 6",
            "type":"number",
            "description":"Schedule of values line descriptive flexfield number attribute 6.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber7":{
            "title":"Number Attribute 7",
            "type":"number",
            "description":"Schedule of values line descriptive flexfield number attribute 7.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber8":{
            "title":"Number Attribute 8",
            "type":"number",
            "description":"Schedule of values line descriptive flexfield number attribute 8.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeNumber9":{
            "title":"Number Attribute 9",
            "type":"number",
            "description":"Schedule of values line descriptive flexfield number attribute 9.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangeIndicator":{
            "title":"Change Indicator",
            "maxLength":255,
            "type":"string",
            "description":"Indicates whether a line has been added or amended when the schedule of values is under revision.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeIndicatorCode":{
            "title":"Change Indicator Code",
            "maxLength":30,
            "type":"string",
            "description":"Nontranslated short code that indicates whether a line has been added or amended when the schedule of values is under revision.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"User who created the line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date and time when the line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Unique identifier for the inventory item associated with the line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "ItemOrganizationId"
                ]
            },
            "x-queryable":true
        },
        "InventoryItemNumber":{
            "title":"Item",
            "maxLength":255,
            "type":"string",
            "description":"Inventory item number associated with the line.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemOrganizationId":{
            "title":"Item Organization ID",
            "type":"integer",
            "description":"Unique identifier for the inventory item organization associated with the line.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date and time when the line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineDescription":{
            "title":"Description",
            "maxLength":2000,
            "type":"string",
            "description":"Description of a schedule of values line.",
            "nullable":false,
            "x-queryable":true
        },
        "LineNumber":{
            "title":"Line",
            "type":"integer",
            "description":"Sequential line number that identifies a schedule of values line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LineStatus":{
            "title":"Status",
            "maxLength":255,
            "type":"string",
            "description":"Status of a schedule of values line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatusCode":{
            "title":"Status Code",
            "maxLength":30,
            "type":"string",
            "description":"Nontranslated short code that indicates the status of a schedule of values line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineType":{
            "title":"Type",
            "maxLength":255,
            "type":"string",
            "description":"Line type of a schedule of values line.",
            "nullable":true,
            "x-queryable":true
        },
        "LineTypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Nontranslated short code that indicates the line type of a schedule of values line.",
            "nullable":false,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"Quantity of a schedule of values line. Context for the quantity is provided by the unit of measure.",
            "nullable":true,
            "x-queryable":true
        },
        "SovLineId":{
            "title":"Line ID",
            "type":"integer",
            "description":"Unique identifier for a schedule of values line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SovVersionId":{
            "title":"Schedule of Values Version ID",
            "type":"integer",
            "description":"Unique identifier for the schedule of values version to which a line is associated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":255,
            "type":"string",
            "description":"Unit of measure of a schedule of values line. Provides context to the quantity and unit price.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasureCode":{
            "title":"Unit of Measure Code",
            "maxLength":30,
            "type":"string",
            "description":"Nontranslated short code that indicates the unit of measure of a schedule of values line.",
            "nullable":false,
            "x-queryable":true
        },
        "UnitPrice":{
            "title":"Unit Price",
            "type":"number",
            "description":"Unit price of a schedule of values line in contract currency.",
            "nullable":true,
            "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"
    }
}

Back to Top