• [0]: object ApiEntitySubmittal

{
    "title":"List<ApiEntitySubmittal>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntitySubmittal"
    }
}

• approvalComment(optional): string
  Additional information about the submittal.
• approvedDate(optional): object TimezoneSensitiveDateTime
• approvingCompanyId(optional): integer(int64)
  Read Only: true

  The company related to the user who approved the submittal.
• approvingCompanyName(optional): string
  Read Only: true

  Name of the approvedBy Company that has to be assigned to the project and Submittals.
• approvingCompanyPostalCode(optional): string
  Read Only: true

  PostalCode of the approvedBy Company that has to be assigned to the project and Submittals.
• approvingUserId(optional): integer(int64)
  Read Only: true

  The user who will approve the submittal.
• approvingUserName(optional): string
  UserName of the approvedBy user, that has to be assigned to submittal.
• ballInCourtId(optional): integer(int64)
  Read Only: true

  The user who is responsible for the submittal.
• codeValues(optional): array codeValues
  Unique Items Required: true

  The categories assigned to a submittal.
• coordinatingCompanyId(optional): integer(int64)
  The company associated with the user who is responsible for reviewing detailed work documents.
• coordinatingCompanyName(optional): string
  Name of the coordinating Company that has to be assigned to the project and Submittals.
• coordinatingCompanyPostalCode(optional): string
  PostalCode of the coordinating Company that has to be assigned to the project and Submittals.
• coordinatingUserId(optional): integer(int64)
  The user who is responsible for reviewing detailed work documents.
• coordinatingUserName(optional): string
  UserName of the coordinating user, that has to be assigned to submittal.
• dateCreated(optional): object TimezoneSensitiveDateTime
• description(optional): string
  Detailed information about the submittal.
• dueDate(optional): string(date-time)
  The date by which the submittal must be approved.
• dueDateChanged(optional): boolean
  Read Only: true

  Indicates whether or not the due date changed.
• flowType(optional): string
  The flow type of a submittal.
• isCustomWorkflowInProgress(optional): boolean
  Read Only: true

  Indicates whether or not a custom workflow is in progress on the submittal.
• isProjectCompanyExists(optional): boolean
  Read Only: true

  Indicates whether or not an assocaited project company exists.
• itemCode(optional): string
  A unique identifier for the submittal.
• itemPrefix(optional): string
  The prefix of the unique identifier of a submittal.
• itemSuffix(optional): integer(int64)
  The suffix of the unique identifier of a submittal.
• link(optional): string(url)
  Read Only: true
• materialDeliveryDate(optional): string(date-time)
  The date by which materials must be delivered.
• priority(optional): string
  Allowed Values: [ "HIGH", "MEDIUM", "NORMAL", "LOW" ]

  The submittal's level of importance. Priority can be set to High, Medium, Normal, or Low.
• projectCode(optional): string
  Project Code of the project, which the Submittal is part of.
• projectId: integer(int64)
  The system-generated identifier of a project.
• requiredAction(optional): string
  Allowed Values: [ "SUBMIT", "REVIEW", "ASSIGN", "FINAL_REVIEW", "NONE", "SUBMIT_REVISION", "RESUBMIT", "SET_AS_DRAFT", "REQUEST_REVISION", "REJECTED" ]

  Indicates whether the submittal requires an action from a user.
• reviewedBy(optional): string
  The user who officially approved the submittal.
• revisionNo(optional): string
  Read Only: true

  This number is automatically generated and based on values in the submittal's Revision fields.
• sendNotification(optional): boolean
  Indicates whether or not changes to the submittal distribute notifications.
• specSectionId: integer(int64)
  The spec section's ID and title.
• specSectionNumber(optional): string
  SpecSectionNumber of the spec section, which submittal is part of.
• status(optional): string
  Allowed Values: [ "DRAFT", "PENDING_REVIEW", "PENDING_APPROVAL", "REJECTED", "APPROVED", "APPROVED_AS_NOTED", "REVISION_NEEDED", "CANCELED" ]

  The status of the submittal. Available Status values include Draft, Pending Review, Pending Approval, Revision Needed, Rejected, Approved, Approved as Noted, and Canceled.
• submitByDate(optional): string(date-time)
  Read Only: true

  The date when the submittal is due by the subcontractor.
• submitByDateChanged(optional): boolean
  Read Only: true

  Indicates whether or not the submit by date has changed.
• submittalConfiguredFields(optional): object ApiEntitySubmittalConfiguredFields
• submittalId(optional): integer(int64)
  A unique identifier for the submittal.
• submittalName: string
  The name of the submittal.
• submittingCompanyId(optional): integer(int64)
  The company associated with the user who is responsible for uploading the submittal document.
• submittingCompanyName(optional): string
  Read Only: true

  Name of the submitting Company that has to be assigned to the project and Submittals.
• submittingCompanyPostalCode(optional): string
  PostalCode of the submitting Company that has to be assigned to the project and Submittals.
• submittingUserId(optional): integer(int64)
  The user who is responsible for uploading the submittal document.
• submittingUserName(optional): string
  The username of the user that submitted the submittal.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workspaceCode(optional): string
  Workspace Code of the workspace, which the project containing the Submittal is part of.

{
    "type":"object",
    "required":[
        "projectId",
        "specSectionId",
        "submittalName"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "priority":{
            "type":"string",
            "description":"The submittal's level of importance. Priority can be set to High, Medium, Normal, or Low.",
            "enum":[
                "HIGH",
                "MEDIUM",
                "NORMAL",
                "LOW"
            ]
        },
        "description":{
            "type":"string",
            "description":"Detailed information about the submittal."
        },
        "status":{
            "type":"string",
            "description":"The status of the submittal. Available Status values include Draft, Pending Review, Pending Approval, Revision Needed, Rejected, Approved, Approved as Noted, and Canceled.",
            "enum":[
                "DRAFT",
                "PENDING_REVIEW",
                "PENDING_APPROVAL",
                "REJECTED",
                "APPROVED",
                "APPROVED_AS_NOTED",
                "REVISION_NEEDED",
                "CANCELED"
            ]
        },
        "itemCode":{
            "type":"string",
            "description":"A unique identifier for the submittal."
        },
        "codeValues":{
            "type":"array",
            "description":"The categories assigned to a submittal.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeValueSubmittal"
            }
        },
        "itemSuffix":{
            "type":"integer",
            "format":"int64",
            "description":"The suffix of the unique identifier of a submittal."
        },
        "itemPrefix":{
            "type":"string",
            "description":"The prefix of the unique identifier of a submittal."
        },
        "workspaceCode":{
            "type":"string",
            "description":"Workspace Code of the workspace, which the project containing the Submittal is part of."
        },
        "submittalName":{
            "type":"string",
            "description":"The name of the submittal."
        },
        "reviewedBy":{
            "type":"string",
            "description":"The user who officially approved the submittal."
        },
        "submittalId":{
            "type":"integer",
            "format":"int64",
            "description":"A unique identifier for the submittal."
        },
        "flowType":{
            "type":"string",
            "description":"The flow type of a submittal."
        },
        "dueDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date by which the submittal must be approved."
        },
        "approvedDate":{
            "description":"The date when the submittal's Status value was set to Approved.",
            "readOnly":true,
            "$ref":"#/definitions/TimezoneSensitiveDateTime"
        },
        "dateCreated":{
            "description":"The Timestamp when the submittal was added.",
            "readOnly":true,
            "$ref":"#/definitions/TimezoneSensitiveDateTime"
        },
        "revisionNo":{
            "type":"string",
            "description":"This number is automatically generated and based on values in the submittal's Revision fields.",
            "readOnly":true
        },
        "projectCode":{
            "type":"string",
            "description":"Project Code of the project, which the Submittal is part of."
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a project."
        },
        "ballInCourtId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who is responsible for the submittal.",
            "readOnly":true
        },
        "approvalComment":{
            "type":"string",
            "description":"Additional information about the submittal."
        },
        "materialDeliveryDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date by which materials must be delivered."
        },
        "sendNotification":{
            "type":"boolean",
            "description":"Indicates whether or not changes to the submittal distribute notifications."
        },
        "submitByDateChanged":{
            "type":"boolean",
            "description":"Indicates whether or not the submit by date has changed.",
            "readOnly":true
        },
        "dueDateChanged":{
            "type":"boolean",
            "description":"Indicates whether or not the due date changed.",
            "readOnly":true
        },
        "isProjectCompanyExists":{
            "type":"boolean",
            "description":"Indicates whether or not an assocaited project company exists.",
            "readOnly":true
        },
        "isCustomWorkflowInProgress":{
            "type":"boolean",
            "description":"Indicates whether or not a custom workflow is in progress on the submittal.",
            "readOnly":true
        },
        "requiredAction":{
            "type":"string",
            "description":"Indicates whether the submittal requires an action from a user.",
            "enum":[
                "SUBMIT",
                "REVIEW",
                "ASSIGN",
                "FINAL_REVIEW",
                "NONE",
                "SUBMIT_REVISION",
                "RESUBMIT",
                "SET_AS_DRAFT",
                "REQUEST_REVISION",
                "REJECTED"
            ]
        },
        "specSectionId":{
            "type":"integer",
            "format":"int64",
            "description":"The spec section's ID and title."
        },
        "submitByDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date when the submittal is due by the subcontractor.",
            "readOnly":true
        },
        "specSectionNumber":{
            "type":"string",
            "description":"SpecSectionNumber of the spec section, which submittal is part of."
        },
        "approvingCompanyName":{
            "type":"string",
            "description":"Name of the approvedBy Company that has to be assigned to the project and Submittals.",
            "readOnly":true
        },
        "submittingCompanyPostalCode":{
            "type":"string",
            "description":"PostalCode of the submitting Company that has to be assigned to the project and Submittals."
        },
        "submittalConfiguredFields":{
            "description":"An object containing configured fields in the form of key-value pairs.",
            "$ref":"#/definitions/ApiEntitySubmittalConfiguredFields"
        },
        "approvingCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The company related to the user who approved the submittal.",
            "readOnly":true
        },
        "submittingUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who is responsible for uploading the submittal document."
        },
        "approvingCompanyPostalCode":{
            "type":"string",
            "description":"PostalCode of the approvedBy Company that has to be assigned to the project and Submittals.",
            "readOnly":true
        },
        "coordinatingUserName":{
            "type":"string",
            "description":"UserName of the coordinating user, that has to be assigned to submittal."
        },
        "submittingCompanyName":{
            "type":"string",
            "description":"Name of the submitting Company that has to be assigned to the project and Submittals.",
            "readOnly":true
        },
        "approvingUserName":{
            "type":"string",
            "description":"UserName of the approvedBy user, that has to be assigned to submittal."
        },
        "coordinatingCompanyPostalCode":{
            "type":"string",
            "description":"PostalCode of the coordinating Company that has to be assigned to the project and Submittals."
        },
        "coordinatingUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who is responsible for reviewing detailed work documents."
        },
        "coordinatingCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The company associated with the user who is responsible for reviewing detailed work documents."
        },
        "submittingCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The company associated with the user who is responsible for uploading the submittal document."
        },
        "approvingUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The user who will approve the submittal.",
            "readOnly":true
        },
        "coordinatingCompanyName":{
            "type":"string",
            "description":"Name of the coordinating Company that has to be assigned to the project and Submittals."
        },
        "submittingUserName":{
            "type":"string",
            "description":"The username of the user that submitted the submittal."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• wrappedDateTime(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "wrappedDateTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

• [0]: object ApiEntityCodeValueSubmittal

{
    "type":"array",
    "description":"The categories assigned to a submittal.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeValueSubmittal"
    }
}

• costFlexMap(optional): object costFlexMap
  Additional Properties Allowed: additionalProperties

  Cost fields assigned to the Submittal with its corresponding value as a (key,value) pair.
• link(optional): string(url)
  Read Only: true
• otherFlexMap(optional): object otherFlexMap
  Additional Properties Allowed: additionalProperties

  Other fields assigned to the Submittal with its corresponding value as a (key,value) pair.
• textFlexMap(optional): object textFlexMap
  Additional Properties Allowed: additionalProperties

  Text fields assigned to the Submittal with its corresponding value as a (key,value) pair.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "costFlexMap":{
            "type":"object",
            "description":"Cost fields assigned to the Submittal with its corresponding value as a (key,value) pair.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "otherFlexMap":{
            "type":"object",
            "description":"Other fields assigned to the Submittal with its corresponding value as a (key,value) pair.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "textFlexMap":{
            "type":"object",
            "description":"Text fields assigned to the Submittal with its corresponding value as a (key,value) pair.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• codeType(optional): object ApiEntityCodeType
• codeValue(optional): object ApiEntityCodeValue
• codeValueSubmittalId(optional): integer(int64)
  The system-generated identifier of a submittal.
• link(optional): string(url)
  Read Only: true
• submittalId(optional): integer(int64)
  The system-generated identifier of a submittal.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValue":{
            "description":"The system-generated identifier of a code value.",
            "$ref":"#/definitions/ApiEntityCodeValue"
        },
        "codeType":{
            "description":"The type of a code.",
            "$ref":"#/definitions/ApiEntityCodeType"
        },
        "submittalId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a submittal."
        },
        "codeValueSubmittalId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a submittal."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• assignments(optional): array assignments
  Unique Items Required: true

  CodeType assignments.
• codeTypeCode: string
  Allowed Values: [ "Length[1-40]" ]

  This field displays the name of a code or value.
• codeTypeId(optional): integer(int64)
  The system-generated identifier of a code type.
• codeTypeName: string
  Allowed Values: [ "Length[1-40]" ]

  The name of a code or value.
• link(optional): string(url)
  Read Only: true
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  The push down type of the workspace code.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workspace: integer(int64)
  The ID of the owning workspace.

{
    "type":"object",
    "required":[
        "codeTypeCode",
        "codeTypeName",
        "pushDownType",
        "workspace"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a code type."
        },
        "codeTypeName":{
            "type":"string",
            "description":"The name of a code or value.",
            "enum":[
                "Length[1-40]"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the workspace code.",
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "assignments":{
            "type":"array",
            "description":"CodeType assignments.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeEntityType"
            }
        },
        "codeTypeCode":{
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "enum":[
                "Length[1-40]"
            ]
        },
        "workspace":{
            "type":"integer",
            "format":"int64",
            "description":"The ID of the owning workspace."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• codeTypeId: integer(int64)
  The ID for the code type.
• codeTypeName: string
  The name of a code or value.
• codeValueCode: string
  Allowed Values: [ "LENGTH[1-32]" ]

  The unique identifier for the code value.
• codeValueId(optional): integer(int64)
  The unique identifier for the code value.
• codeValueName: string
  Allowed Values: [ "LENGTH[1-100]" ]

  The name of the code value.
• link(optional): string(url)
  Read Only: true
• parentCodeValue(optional): integer(int64)
  The parent code value.
• sequenceNumber: integer(int32)
  The number that specifies the position of the code value item within the code type list.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "codeTypeId",
        "codeTypeName",
        "codeValueCode",
        "codeValueName",
        "sequenceNumber"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValueId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the code value."
        },
        "codeTypeId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID for the code type."
        },
        "codeValueName":{
            "type":"string",
            "description":"The name of the code value.",
            "enum":[
                "LENGTH[1-100]"
            ]
        },
        "codeValueCode":{
            "type":"string",
            "description":"The unique identifier for the code value.",
            "enum":[
                "LENGTH[1-32]"
            ]
        },
        "codeTypeName":{
            "type":"string",
            "description":"The name of a code or value."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int32",
            "description":"The number that specifies the position of the code value item within the code type list."
        },
        "parentCodeValue":{
            "type":"integer",
            "format":"int64",
            "description":"The parent code value."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• [0]: object ApiEntityCodeEntityType

{
    "type":"array",
    "description":"CodeType assignments.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeEntityType"
    }
}

• codeType: object ApiEntityCodeType
• entityType: string
  Allowed Values: [ "SCOPE_ITEM", "PROJECT", "SCOPE_ASSIGNMENT", "WBS", "WORK_PACKAGE", "ACTIVITY", "RESOURCE", "PBS", "CONTRACT", "RISK", "COMMITMENT", "REPORT", "TASKS", "STRATEGY", "PORTFOLIO", "FUND", "SUBMITTAL", "CHANGE_ORDER", "PAYMENT_APPLICATION", "CHANGE_EVENT", "CHANGES_ESTIMATES", "IDEA", "RFI", "CUSTOM_LOG_ITEM" ]

  Indicates the type of object the code is associated to.
• link(optional): string(url)
  Read Only: true
• primaryKey: integer(int64)
  The unique identifier of a code type table.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "codeType",
        "entityType",
        "primaryKey"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeType":{
            "description":"The unique identifier of a code type.",
            "$ref":"#/definitions/ApiEntityCodeType"
        },
        "entityType":{
            "type":"string",
            "description":"Indicates the type of object the code is associated to.",
            "enum":[
                "SCOPE_ITEM",
                "PROJECT",
                "SCOPE_ASSIGNMENT",
                "WBS",
                "WORK_PACKAGE",
                "ACTIVITY",
                "RESOURCE",
                "PBS",
                "CONTRACT",
                "RISK",
                "COMMITMENT",
                "REPORT",
                "TASKS",
                "STRATEGY",
                "PORTFOLIO",
                "FUND",
                "SUBMITTAL",
                "CHANGE_ORDER",
                "PAYMENT_APPLICATION",
                "CHANGE_EVENT",
                "CHANGES_ESTIMATES",
                "IDEA",
                "RFI",
                "CUSTOM_LOG_ITEM"
            ]
        },
        "primaryKey":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a code type table."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"Cost fields assigned to the Submittal with its corresponding value as a (key,value) pair.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"Other fields assigned to the Submittal with its corresponding value as a (key,value) pair.",
    "additionalProperties":{
        "type":"object"
    }
}

• object additionalProperties

{
    "type":"object",
    "description":"Text fields assigned to the Submittal with its corresponding value as a (key,value) pair.",
    "additionalProperties":{
        "type":"object"
    }
}