• [0]: object ApiEntityResource

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityResource"
    }
}

• addressLine1(optional): string
  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2(optional): string
  The second line of the address of a location.
  This might be a neighborhood or town.
• applicationUserId(optional): integer(int64)
  The name of the user in the application that is also a resource.
• calendar(optional): integer(int64)
  The calendar assigned to the resource or role.
• calendarName(optional): string
  The name of the calendar.
• cityName(optional): string
  The city name for a location.
• codeValuesResource(optional): array codeValuesResource
  Unique Items Required: true

  An array of code values for this resource object.
• costQuantityType(optional): string
  Allowed Values: [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ]

  The type of costs associated with a resource.
• countryCode(optional): string
  The country for a location.
• defaultSyncUnitsFromCost(optional): boolean
  Sync units from cost.
• defaultUnitsPerHour(optional): object Unit
• description(optional): string
  Additional information for the resource or the role.
• emailAddress(optional): string
  The email address for the resource.
• employeeNumber(optional): string
  The resource identifier within the organization, typically the employee number or social security number.
• latitude(optional): number(double)
  The geographical coordinate for the latitude of the location.
  The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• link(optional): string(url)
  Read Only: true
• longitude(optional): number(double)
  The geographical coordinate for the longitude of the location.
  The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service.
• officePhoneNumber(optional): string
  The office phone number for the resource.
• otherPhoneNumber(optional): string
  The alternate phone numbers for the resource.
• overtimeFactor(optional): number(double)
  The overtime factor used to compute the overtime price for the resource.
• parent(optional): integer(int64)
  The unique identifier for the parent resource or role.
• postalCode(optional): string
  The postal code, post code, or zip code of a location.
• projectId(optional): integer(int64)
  The unique identifier for the project.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The resource type. Valid values are:
  Labor: Indicates that the selected resource performs labor, measured in units of time.
  Nonlabor: Indicates that the selected resource does not perform labor, measured in units of time. Equipment is a nonlabor resource.
  Material: Indicates that the resource has a unit of measure other than time. You can select a unit of measure for the material resource.
• resourceCode: string
  The unique identifier for the resource or role.
• resourceId(optional): integer(int64)
  The unique identifier for the resource or role. This value should not be provided in create operation request data, however, it is required for update requests.
• resourceManagerId(optional): integer(int64)
  The person designated as the manager for the resource.
• resourceName: string
  The name of the resource or role.
• resourceOwnershipType(optional): string
  Allowed Values: [ "WORKSPACE", "PROJECT" ]

  The type of ownership for a resource. Possible values include Workspace and Project.
• resourceRoleId(optional): integer(int64)
  The identifier for the role assigned to the resource.
• resourceStatus: string
  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  Determines whether the resource or role is currently active.
  Inactive resources might have left the organization, but are not deleted from the system because they might have been assigned an activity in the past or have incurred actual hours.
• resourceTitleName(optional): string
  The job title for the resource.
  For example, a resource may have the title Senior Engineer.
• resourceType: string
  Allowed Values: [ "LABOR", "NONLABOR", "MATERIAL", "ROLE" ]

  The resource type. Valid values are:
  Labor: Indicates that the selected resource performs labor, measured in units of time.
  Nonlabor: Indicates that the selected resource does not perform labor, measured in units of time. Equipment is a nonlabor resource.
  Material: Indicates that the resource has a unit of measure other than time. You can select a unit of measure for the material resource.
• sourceId(optional): string
  The unique identifier of resource data in an external source.
• stateCode(optional): string
  A unique identifier for the state or province.
• stateName(optional): string
  The state, region, or province of a location.
• unitOfMeasureCode(optional): string
  The abbreviation for the unit of measure name.
• unitOfMeasureId(optional): integer(int64)
  The unit of measure used for the material resource.
• 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.
• workspaceId: integer(int64)
  The name of the workspace where the resource or role was created.
• workspaceName(optional): string
  Name of a workspace.

{
    "type":"object",
    "required":[
        "resourceClass",
        "resourceCode",
        "resourceName",
        "resourceStatus",
        "resourceType",
        "workspaceId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "parent":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the parent resource or role."
        },
        "calendar":{
            "type":"integer",
            "format":"int64",
            "description":"The calendar assigned to the resource or role."
        },
        "unitOfMeasureId":{
            "type":"integer",
            "format":"int64",
            "description":"The unit of measure used for the material resource."
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The name of the workspace where the resource or role was created."
        },
        "description":{
            "type":"string",
            "description":"Additional information for the resource or the role."
        },
        "calendarName":{
            "type":"string",
            "description":"The name of the calendar."
        },
        "resourceType":{
            "type":"string",
            "description":"The resource type. Valid values are: <br />Labor: Indicates that the selected resource performs labor, measured in units of time. <br />Nonlabor: Indicates that the selected resource does not perform labor, measured in units of time. Equipment is a nonlabor resource. <br />Material: Indicates that the resource has a unit of measure other than time. You can select a unit of measure for the material resource.",
            "enum":[
                "LABOR",
                "NONLABOR",
                "MATERIAL",
                "ROLE"
            ]
        },
        "resourceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the resource or role. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "resourceCode":{
            "type":"string",
            "description":"The unique identifier for the resource or role."
        },
        "resourceClass":{
            "type":"string",
            "description":"The resource type. Valid values are: <br />Labor: Indicates that the selected resource performs labor, measured in units of time. <br />Nonlabor: Indicates that the selected resource does not perform labor, measured in units of time. Equipment is a nonlabor resource. <br />Material: Indicates that the resource has a unit of measure other than time. You can select a unit of measure for the material resource.",
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "resourceName":{
            "type":"string",
            "description":"The name of the resource or role."
        },
        "workspaceName":{
            "type":"string",
            "description":"Name of a workspace."
        },
        "countryCode":{
            "type":"string",
            "description":"The country for a location."
        },
        "addressLine1":{
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address."
        },
        "stateName":{
            "type":"string",
            "description":"The state, region, or province of a location."
        },
        "addressLine2":{
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town."
        },
        "postalCode":{
            "type":"string",
            "description":"The postal code, post code, or zip code of a location."
        },
        "latitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the latitude of the location. <br />The default format for latitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "cityName":{
            "type":"string",
            "description":"The city name for a location."
        },
        "stateCode":{
            "type":"string",
            "description":"A unique identifier for the state or province."
        },
        "longitude":{
            "type":"number",
            "format":"double",
            "description":"The geographical coordinate for the longitude of the location. <br />The default format for longitude is decimal degrees format, but the format you need to use will depend on your geolocation service."
        },
        "sourceId":{
            "type":"string",
            "description":"The unique identifier of resource data in an external source."
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the project."
        },
        "emailAddress":{
            "type":"string",
            "description":"The email address for the resource."
        },
        "resourceStatus":{
            "type":"string",
            "description":"Determines whether the resource or role is currently active. <br />Inactive resources might have left the organization, but are not deleted from the system because they might have been assigned an activity in the past or have incurred actual hours.",
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "defaultSyncUnitsFromCost":{
            "type":"boolean",
            "description":"Sync units from cost."
        },
        "defaultUnitsPerHour":{
            "description":"The default unit/time is the maximum work units per time a resource or role can perform on all their assigned activities. The value is shown as either a percentage or units/duration depending on the user settings. If the Resource Type is Material, then units/duration are always displayed. <br />For example, if the selected resource is one person, a reasonable value may be 8 hours (units) per day (duration). In this case, the Max Units/Time would be 8.00h/d, or 8 hours of work per day, which is represented as 100%.",
            "$ref":"#/definitions/Unit"
        },
        "costQuantityType":{
            "type":"string",
            "description":"The type of costs associated with a resource.",
            "enum":[
                "HOUR",
                "DAY",
                "WEEK",
                "MONTH",
                "YEAR"
            ]
        },
        "otherPhoneNumber":{
            "type":"string",
            "description":"The alternate phone numbers for the resource."
        },
        "resourceTitleName":{
            "type":"string",
            "description":"The job title for the resource. <br />For example, a resource may have the title Senior Engineer."
        },
        "employeeNumber":{
            "type":"string",
            "description":"The resource identifier within the organization, typically the employee number or social security number."
        },
        "resourceRoleId":{
            "type":"integer",
            "format":"int64",
            "description":"The identifier for the role assigned to the resource."
        },
        "resourceOwnershipType":{
            "type":"string",
            "description":"The type of ownership for a resource. Possible values include Workspace and Project.",
            "enum":[
                "WORKSPACE",
                "PROJECT"
            ]
        },
        "officePhoneNumber":{
            "type":"string",
            "description":"The office phone number for the resource."
        },
        "overtimeFactor":{
            "type":"number",
            "format":"double",
            "description":"The overtime factor used to compute the overtime price for the resource."
        },
        "applicationUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The name of the user in the application that is also a resource."
        },
        "unitOfMeasureCode":{
            "type":"string",
            "description":"The abbreviation for the unit of measure name."
        },
        "resourceManagerId":{
            "type":"integer",
            "format":"int64",
            "description":"The person designated as the manager for the resource."
        },
        "codeValuesResource":{
            "type":"array",
            "description":"An array of code values for this resource object.",
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityCodeValueResource"
            }
        },
        "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 ApiEntityCodeValueResource

{
    "type":"array",
    "description":"An array of code values for this resource object.",
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityCodeValueResource"
    }
}

• codeType(optional): object ApiEntityCodeType
• codeValue: object ApiEntityCodeValue
• codeValueResourceId: integer(int64)
  The unique identifier of the resource assigned to the code value. This value should not be provided in create operation request data, however, it is required for update requests.
• link(optional): string(url)
  Read Only: true
• resourceId(optional): integer(int64)
  The unique identifier for the resource assigned to the code value.
• 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":[
        "codeValue",
        "codeValueResourceId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "codeValue":{
            "description":"The name of the resource code value.",
            "$ref":"#/definitions/ApiEntityCodeValue"
        },
        "codeType":{
            "description":"The ID for the code type.",
            "$ref":"#/definitions/ApiEntityCodeType"
        },
        "resourceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier for the resource assigned to the code value."
        },
        "codeValueResourceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the resource assigned to the code value. This value should not be provided in create operation request data, however, it is required for update requests."
        },
        "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
        }
    }
}