Jump to

• Request
• Response

Batch Integrate Resources with an External Data Source

post

/api/restapi/resource/syncBatch

Send a request to this endpoint to create or update one or more integrated resources. If an object provided in the request body does not exist in the application, an object is created using the request data. Integrated objects can only be modified using the API.

Request

Header Parameters

• singleTransaction: boolean
  Enabling this boolean flag will fail the request if an error occurs while processing any resource sent as part of the request.
  Allowed Values: [ "true", "false" ]

  Default Value: false

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityExternallySourcedResourceInput>

Type: array

Title: List<ApiEntityExternallySourcedResourceInput>

Show Source

• Array of: object ApiEntityExternallySourcedResourceInput
  Title: ApiEntityExternallySourcedResourceInput

  This entity represents a ExternallySourcedResource object, a unique ExternallySourcedResource object can be identified by the following combinations of the fields.

  • resourceId
  • resourceCode,resourceClass,workspaceId
  • resourceCode,resourceClass,workspaceCode
  • resourceCode,resourceClass,projectId
  • resourceCode,resourceClass,projectCode,workspaceCode

{
    "title":"List<ApiEntityExternallySourcedResourceInput>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityExternallySourcedResourceInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityExternallySourcedResourceInput

Type: object

Title: ApiEntityExternallySourcedResourceInput

This entity represents a ExternallySourcedResource object, a unique ExternallySourcedResource object can be identified by the following combinations of the fields.

• resourceId
• resourceCode,resourceClass,workspaceId
• resourceCode,resourceClass,workspaceCode
• resourceCode,resourceClass,projectId
• resourceCode,resourceClass,projectCode,workspaceCode

Show Source

• addressLine1: string
  Minimum Length: 0

  Maximum Length: 200

  The first line of the address of a location.
  This might be the building number and street address.
• addressLine2: string
  Minimum Length: 0

  Maximum Length: 200

  The second line of the address of a location.
  This might be a neighborhood or town.
• applicationUserId: integer (int64)
  The name of the user in the application that is also a resource.
• calendar: integer (int64)
  The calendar assigned to the resource or role.
• calendarCode: string
  Minimum Length: 0

  Maximum Length: 255

  The unique code for the calendar.
• cityName: string
  Minimum Length: 0

  Maximum Length: 200

  The city name for a location.
• codeValuesResource: array codeValuesResource
  The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.
• costQuantityType: string
  Allowed Values: [ "HOUR", "DAY", "WEEK", "MONTH", "YEAR" ]

  The type of costs associated with a resource.
• countryCode: string
  Minimum Length: 0

  Maximum Length: 3

  The country for a location.
• defaultUnitsPerHour: number (double)
  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.
  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%.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  Additional information for the resource or the role.
• emailAddress: string
  Minimum Length: 0

  Maximum Length: 255

  The email address for the resource.
• employeeNumber: string
  Minimum Length: 0

  Maximum Length: 60

  The resource identifier within the organization, typically the employee number or social security number.
• isUser: boolean
  Indicates whether or not this resource is an application user.
• latitude: number (double)
  Minimum Value: -90

  Maximum Value: 90

  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.
• longitude: number (double)
  Minimum Value: -180

  Maximum Value: 180

  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.
• managerName: string
  Maximum Length: 255

  The name of the manager associated with the resource.
• officePhoneNumber: string
  Minimum Length: 0

  Maximum Length: 32

  The office phone number for the resource.
• otherPhoneNumber: string
  Minimum Length: 0

  Maximum Length: 32

  The alternate phone numbers for the resource.
• overtimeFactor: number (double)
  The overtime factor used to compute the overtime price for the resource.
• parentId: integer (int64)
  The unique identifier for the parent resource or role.
• parentResourceCode: string
  Minimum Length: 1

  Maximum Length: 60

  The parent resource code of a resource.
• postalCode: string
  Minimum Length: 0

  Maximum Length: 20

  The postal code, post code, or zip code of a location.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• resourceClass(required): string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId: integer (int64)
  The unique identifier for the resource or role.
• resourceManagerId: integer (int64)
  The person designated as the manager for the resource.
• resourceName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the resource or role.
• resourceOwnershipType: string
  Allowed Values: [ "WORKSPACE", "PROJECT" ]

  The type of ownership for a resource. Possible values include Workspace and Project.
• resourceRoleAssignments: array resourceRoleAssignments
  The role assignment associated with the resource.
• resourceRoleId: integer (int64)
  The identifier for the role assigned to the resource.
• resourceStatus(required): 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: string
  Minimum Length: 0

  Maximum Length: 255

  The job title for the resource.
  For example, a resource may have the title Senior Engineer.
• resourceType(required): string
  Allowed Values: [ "LABOR", "NONLABOR", "MATERIAL" ]

  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.
• resourceWorkRates: array resourceWorkRates
  The work rates of the resource.
• sourceId: string
  Maximum Length: 255

  The unique identifier of resource data in an external source.
• stateCode: string
  Minimum Length: 0

  Maximum Length: 2

  A unique identifier for the state or province.
• stateName: string
  Minimum Length: 0

  Maximum Length: 200

  The state, region, or province of a location.
• unitOfMeasureCode: string
  Minimum Length: 0

  Maximum Length: 60

  The abbreviation for the unit of measure name.
• unitOfMeasureId: integer (int64)
  The unit of measure used for the material resource.
• user: user
  The user associated with the resource.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityExternallySourcedResourceInput",
    "required":[
        "resourceClass",
        "resourceCode",
        "resourceStatus",
        "resourceType",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "resourceWorkRates":{
            "type":"array",
            "description":"The work rates of the resource.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityResourceWorkRateInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "resourceRoleAssignments":{
            "type":"array",
            "description":"The role assignment associated with the resource.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityResourceRoleAssignmentInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "managerName":{
            "maxLength":255,
            "type":"string",
            "description":"The name of the manager associated with the resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "isUser":{
            "type":"boolean",
            "description":"Indicates whether or not this resource is an application user.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "user":{
            "description":"The user associated with the resource.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityExternallySourcedUser"
                }
            ]
        },
        "calendar":{
            "type":"integer",
            "description":"The calendar assigned to the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "unitOfMeasureId":{
            "type":"integer",
            "description":"The unit of measure used for the material resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValuesResource":{
            "type":"array",
            "description":"The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityCodeValueResourceInput",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "description":{
            "maxLength":4000,
            "minLength":0,
            "type":"string",
            "description":"Additional information for the resource or the role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "emailAddress":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The email address for the resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "employeeNumber":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The resource identifier within the organization, typically the employee number or social security number.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "overtimeFactor":{
            "type":"number",
            "description":"The overtime factor used to compute the overtime price for the resource.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "officePhoneNumber":{
            "maxLength":32,
            "minLength":0,
            "type":"string",
            "description":"The office phone number for the resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "unitOfMeasureCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The abbreviation for the unit of measure name.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "otherPhoneNumber":{
            "maxLength":32,
            "minLength":0,
            "type":"string",
            "description":"The alternate phone numbers for the resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceOwnershipType":{
            "type":"string",
            "description":"The type of ownership for a resource. Possible values include Workspace and Project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "WORKSPACE",
                "PROJECT"
            ]
        },
        "resourceManagerId":{
            "type":"integer",
            "description":"The person designated as the manager for the resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceTitleName":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The job title for the resource. <br />For example, a resource may have the title Senior Engineer.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "costQuantityType":{
            "type":"string",
            "description":"The type of costs associated with a resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "HOUR",
                "DAY",
                "WEEK",
                "MONTH",
                "YEAR"
            ]
        },
        "parentResourceCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The parent resource code of a resource.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUserId":{
            "type":"integer",
            "description":"The name of the user in the application that is also a resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "defaultUnitsPerHour":{
            "type":"number",
            "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%.",
            "format":"double",
            "exampleSetFlag":false
        },
        "resourceRoleId":{
            "type":"integer",
            "description":"The identifier for the role assigned to the resource.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "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.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "LABOR",
                "NONLABOR",
                "MATERIAL"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "resourceCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine1":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"The first line of the address of a location. <br />This might be the building number and street address.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "addressLine2":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"The second line of the address of a location. <br />This might be a neighborhood or town.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "cityName":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"The city name for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "stateName":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"The state, region, or province of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "postalCode":{
            "maxLength":20,
            "minLength":0,
            "type":"string",
            "description":"The postal code, post code, or zip code of a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "countryCode":{
            "maxLength":3,
            "minLength":0,
            "type":"string",
            "description":"The country for a location.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "longitude":{
            "maximum":180,
            "minimum":-180,
            "type":"number",
            "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.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "latitude":{
            "maximum":90,
            "minimum":-90,
            "type":"number",
            "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.",
            "format":"double",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "stateCode":{
            "maxLength":2,
            "minLength":0,
            "type":"string",
            "description":"A unique identifier for the state or province.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier for the parent resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of resource data in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "calendarCode":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"The unique code for the calendar.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ExternallySourcedResource object, a unique ExternallySourcedResource object can be identified by the following combinations of the fields.<ul><li>resourceId</li><li>resourceCode,resourceClass,workspaceId</li><li>resourceCode,resourceClass,workspaceCode</li><li>resourceCode,resourceClass,projectId</li><li>resourceCode,resourceClass,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : codeValuesResource

Type: array

The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.

Show Source

• Array of: object ApiEntityCodeValueResourceInput
  Title: ApiEntityCodeValueResourceInput

  This entity represents a CodeValueResource object, a unique CodeValueResource object can be identified by the following combinations of the fields.

  • codeValueResourceId
  • codeValueId
  • codeTypeId,codeValueCode
  • codeTypeCode,codeValueCode
  • codeTypeCode,parentId,codeValueCode
  • codeValueCode,codeTypeId,parentId
  • codeTypeCode,codeValueCode,projectCode
  • codeTypeCode,codeValueCode,projectId
  • codeTypeCode,codeValueCode,parentId,projectCode
  • codeTypeCode,codeValueCode,parentId,projectId

{
    "type":"array",
    "description":"The list of code values for a resource. This entity can only be used to assign codeValues or create codeValues on the fly.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCodeValueResourceInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : resourceRoleAssignments

Type: array

The role assignment associated with the resource.

Show Source

• Array of: object ApiEntityResourceRoleAssignmentInput
  Title: ApiEntityResourceRoleAssignmentInput

  This entity represents a ResourceRoleAssignment object, a unique ResourceRoleAssignment object can be identified by the following combinations of the fields.

  • resourceRoleAssignmentId
  • resourceId,roleId
  • resourceCode,workspaceCode,roleId
  • resourceId,workspaceCode,roleCode
  • resourceCode,workspaceCode,roleCode

{
    "type":"array",
    "description":"The role assignment associated with the resource.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityResourceRoleAssignmentInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : resourceWorkRates

Type: array

The work rates of the resource.

Show Source

• Array of: object ApiEntityResourceWorkRateInput
  Title: ApiEntityResourceWorkRateInput

  This entity represents a ResourceWorkRate object, a unique ResourceWorkRate object can be identified by the following combinations of the fields.

  • resourceWorkRateId
  • effectiveStartDate,workspaceResourceId
  • effectiveStartDate,resourceId,workspaceId
  • effectiveStartDate,resourceId,workspaceCode
  • effectiveStartDate,resourceCode,resourceClass,workspaceId
  • effectiveStartDate,resourceCode,resourceClass,workspaceCode

{
    "type":"array",
    "description":"The work rates of the resource.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityResourceWorkRateInput",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : user

The user associated with the resource.

Match All

The user associated with the resource.

Show Source

• object ApiEntityExternallySourcedUser
  Title: ApiEntityExternallySourcedUser

{
    "description":"The user associated with the resource.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityExternallySourcedUser"
        }
    ]
}

Nested Schema : ApiEntityCodeValueResourceInput

Type: object

Title: ApiEntityCodeValueResourceInput

This entity represents a CodeValueResource object, a unique CodeValueResource object can be identified by the following combinations of the fields.

• codeValueResourceId
• codeValueId
• codeTypeId,codeValueCode
• codeTypeCode,codeValueCode
• codeTypeCode,parentId,codeValueCode
• codeValueCode,codeTypeId,parentId
• codeTypeCode,codeValueCode,projectCode
• codeTypeCode,codeValueCode,projectId
• codeTypeCode,codeValueCode,parentId,projectCode
• codeTypeCode,codeValueCode,parentId,projectId

Show Source

• action: string
  Allowed Values: [ "DELETE" ]

  Provide a value for this field during object update to delete code value assigned to the object.
• codeTypeCode: string
  Minimum Length: 0

  Maximum Length: 60

  This field displays the name of a code or value.
• codeTypeId(required): integer (int64)
  The unique identifier for the code type.The code type object can also be identified by its unique criteria.
• codeValueCode(required): string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the code value.
• codeValueId: integer (int64)
  The unique identifier for the code value.
• codeValueName: string
  Minimum Length: 1

  Maximum Length: 255

  The name of the code value.
• codeValueResourceId: integer (int64)
  The unique identifier of the resource assigned to the code value.
• parentId: integer (int64)
  The unique identifier of a parent code value.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The code of a Project of a Project CodeType.
• projectId: integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• resourceId: integer (int64)
  The unique identifier for the resource assigned to the code value.

{
    "title":"ApiEntityCodeValueResourceInput",
    "required":[
        "codeTypeId",
        "codeValueCode"
    ],
    "type":"object",
    "properties":{
        "codeValueResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource assigned to the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource assigned to the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeId":{
            "type":"integer",
            "description":"The unique identifier for the code type.The code type object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeTypeCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"This field displays the name of a code or value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueId":{
            "type":"integer",
            "description":"The unique identifier for the code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "codeValueName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "codeValueCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the code value.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The unique identifier of a parent code value.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "action":{
            "type":"string",
            "description":"Provide a value for this field during object update to delete code value assigned to the object.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "DELETE"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The code of a Project of a Project CodeType.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a CodeValueResource object, a unique CodeValueResource object can be identified by the following combinations of the fields.<ul><li>codeValueResourceId</li><li>codeValueId</li><li>codeTypeId,codeValueCode</li><li>codeTypeCode,codeValueCode</li><li>codeTypeCode,parentId,codeValueCode</li><li>codeValueCode,codeTypeId,parentId</li><li>codeTypeCode,codeValueCode,projectCode</li><li>codeTypeCode,codeValueCode,projectId</li><li>codeTypeCode,codeValueCode,parentId,projectCode</li><li>codeTypeCode,codeValueCode,parentId,projectId</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityResourceRoleAssignmentInput

Type: object

Title: ApiEntityResourceRoleAssignmentInput

This entity represents a ResourceRoleAssignment object, a unique ResourceRoleAssignment object can be identified by the following combinations of the fields.

• resourceRoleAssignmentId
• resourceId,roleId
• resourceCode,workspaceCode,roleId
• resourceId,workspaceCode,roleCode
• resourceCode,workspaceCode,roleCode

Show Source

• primaryFlag: boolean
  Determines whether this is the resource's main role. A role that does not have this option selected indicates that this is a secondary role for the resource. You can only assign one primary role per resource. A resource is not required to have a primary role.
• proficiency: string
  Allowed Values: [ "ONE", "TWO", "THREE", "FOUR", "FIVE" ]

  The skill level of the resource.
  Skill levels are Master, Expert, Skilled, Proficient, and Inexperienced.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• resourceCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId(required): integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.
• resourceRoleAssignmentId: integer (int64)
  The system-generated identifier of the resource role assignment.
• roleCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of the role.
• roleId(required): integer (int64)
  The unique identifier for the role.The role object can also be identified by its unique criteria.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityResourceRoleAssignmentInput",
    "required":[
        "resourceId",
        "roleId"
    ],
    "type":"object",
    "properties":{
        "roleId":{
            "type":"integer",
            "description":"The unique identifier for the role.The role object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "roleCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The user-specified identifier of the role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceRoleAssignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of the resource role assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "primaryFlag":{
            "type":"boolean",
            "description":"Determines whether this is the resource's main role. A role that does not have this option selected indicates that this is a secondary role for the resource. You can only assign one primary role per resource. A resource is not required to have a primary role.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "proficiency":{
            "type":"string",
            "description":"The skill level of the resource. <br />Skill levels are Master, Expert, Skilled, Proficient, and Inexperienced.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ONE",
                "TWO",
                "THREE",
                "FOUR",
                "FIVE"
            ]
        },
        "resourceCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ResourceRoleAssignment object, a unique ResourceRoleAssignment object can be identified by the following combinations of the fields.<ul><li>resourceRoleAssignmentId</li><li>resourceId,roleId</li><li>resourceCode,workspaceCode,roleId</li><li>resourceId,workspaceCode,roleCode</li><li>resourceCode,workspaceCode,roleCode</li>",
    "exampleSetFlag":false
}

Nested Schema : ApiEntityResourceWorkRateInput

Type: object

Title: ApiEntityResourceWorkRateInput

This entity represents a ResourceWorkRate object, a unique ResourceWorkRate object can be identified by the following combinations of the fields.

• resourceWorkRateId
• effectiveStartDate,workspaceResourceId
• effectiveStartDate,resourceId,workspaceId
• effectiveStartDate,resourceId,workspaceCode
• effectiveStartDate,resourceCode,resourceClass,workspaceId
• effectiveStartDate,resourceCode,resourceClass,workspaceCode

Show Source

• effectiveStartDate(required): string (date-time)
  The date that the corresponding units/time period and rates go into effect for the resource or role.
• maxUnitsPerTime(required): number (double)
  The maximum work units per time the resource or role can perform on all their assigned activities
  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. Similarly, if the selected resource is a department with 5 people, then the Max Units/Time may be 40.00h/d. This means that 5 people can perform 40 hours of work per day, rather than 1 person performing 8 hours of work per day.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId(required): integer (int64)
  The unique identifier for the resource or role.
• resourceWorkRateCost: resourceWorkRateCost
  An entity containing the price per unit fields of a resource work rate.
• resourceWorkRateId: integer (int64)
  The system-generated identifier of the work rate.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.
• workspaceResourceId: integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.

{
    "title":"ApiEntityResourceWorkRateInput",
    "required":[
        "effectiveStartDate",
        "maxUnitsPerTime",
        "resourceId",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "maxUnitsPerTime":{
            "type":"number",
            "description":"The maximum work units per time the resource or role can perform on all their assigned activities <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. Similarly, if the selected resource is a department with 5 people, then the Max Units/Time may be 40.00h/d. This means that 5 people can perform 40 hours of work per day, rather than 1 person performing 8 hours of work per day.",
            "format":"double",
            "exampleSetFlag":false
        },
        "effectiveStartDate":{
            "type":"string",
            "description":"The date that the corresponding units/time period and rates go into effect for the resource or role.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceResourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceWorkRateId":{
            "type":"integer",
            "description":"The system-generated identifier of the work rate.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceWorkRateCost":{
            "description":"An entity containing the price per unit fields of a resource work rate.",
            "exampleSetFlag":false,
            "allOf":[
                {
                    "$ref":"#/components/schemas/ApiEntityResourceWorkRateCostInput"
                }
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "resourceCode":{
            "maxLength":60,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ResourceWorkRate object, a unique ResourceWorkRate object can be identified by the following combinations of the fields.<ul><li>resourceWorkRateId</li><li>effectiveStartDate,workspaceResourceId</li><li>effectiveStartDate,resourceId,workspaceId</li><li>effectiveStartDate,resourceId,workspaceCode</li><li>effectiveStartDate,resourceCode,resourceClass,workspaceId</li><li>effectiveStartDate,resourceCode,resourceClass,workspaceCode</li>",
    "exampleSetFlag":false
}

Nested Schema : resourceWorkRateCost

An entity containing the price per unit fields of a resource work rate.

Match All

An entity containing the price per unit fields of a resource work rate.

Show Source

• object ApiEntityResourceWorkRateCostInput
  Title: ApiEntityResourceWorkRateCostInput

{
    "description":"An entity containing the price per unit fields of a resource work rate.",
    "exampleSetFlag":false,
    "allOf":[
        {
            "$ref":"#/components/schemas/ApiEntityResourceWorkRateCostInput"
        }
    ]
}

Nested Schema : ApiEntityResourceWorkRateCostInput

Type: object

Title: ApiEntityResourceWorkRateCostInput

Show Source

• pricePerUnit1: number (double)
  Minimum Value: 0

  The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
• pricePerUnit2: number (double)
  Minimum Value: 0

  The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
• pricePerUnit3: number (double)
  Minimum Value: 0

  The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
• pricePerUnit4: number (double)
  Minimum Value: 0

  The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
• pricePerUnit5: number (double)
  Minimum Value: 0

  The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.
• resourceWorkRateId: integer (int64)
  The system-generated identifier of the work rate.

{
    "title":"ApiEntityResourceWorkRateCostInput",
    "type":"object",
    "properties":{
        "pricePerUnit1":{
            "minimum":0,
            "type":"number",
            "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pricePerUnit2":{
            "minimum":0,
            "type":"number",
            "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pricePerUnit4":{
            "minimum":0,
            "type":"number",
            "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pricePerUnit3":{
            "minimum":0,
            "type":"number",
            "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.",
            "format":"double",
            "exampleSetFlag":false
        },
        "pricePerUnit5":{
            "minimum":0,
            "type":"number",
            "description":"The price per unit associated with the resource or role. The price per unit is used to calculate costs for resources or roles assigned to activities.",
            "format":"double",
            "exampleSetFlag":false
        },
        "resourceWorkRateId":{
            "type":"integer",
            "description":"The system-generated identifier of the work rate.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityExternallySourcedUser

Type: object

Title: ApiEntityExternallySourcedUser

Show Source

• companyId: integer (int64)
  The company the user is associated with.
• email(required): string
  Maximum Length: 320

  The email address of a user.
• firstName(required): string
  Maximum Length: 100

  The first name of a user.
• lastLogInTime: string (date-time)
  The date and time the user last logged into the application.
• lastName(required): string
  Maximum Length: 100

  The last name of a user.
• ldapGuid: string
  Minimum Length: 1

  Maximum Length: 255

  The unique identifier in the external authentication system (LDAP or IDCS).
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• mobile: string
  Maximum Length: 100

  The mobile phone number of a user.
• phone: string
  Maximum Length: 100

  The phone number of a user.
• restrictedUser: boolean
  Indicates that the user can only access records associated with the assigned company.
• status: string
  Maximum Length: 20

  Allowed Values: [ "ACTIVE", "INACTIVE" ]

  Determines the status of the user. When a user is inactive, they can no longer have access to login. Valid Values are ACTIVE and INACTIVE.
• title: string
  Maximum Length: 25

  The title of a user.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• userId: integer (int64)
  The system-generated identifier of a user.
• userLocale: string
  The language code for a user.

  1. pt_BR - Brazilian Portuguese
  2. nl - Dutch
  3. en - English
  4. fr - French
  5. de - German
  6. it - Italian
  7. ja - Japanese
  8. ko - Korean
  9. ru - Russian
  10. zh_CN - Simplified Chinese
  11. es - Spanish
  12. zh_TW - Traditional Chinese
• userName: string
  Minimum Length: 1

  Maximum Length: 255

  The identification used by a user to log in to the system.
• userProducts: array userProducts
  A list of all user product fields and values in the form of key value pairs.
• userSettings: array userSettings
  A list of all user setting fields and values in the form of key value pairs.
• userType: string
  Allowed Values: [ "USER", "COMPANY_RESTRICTED", "APPLICATION_ADMIN", "IDEA_SUBMITTER" ]

  The type of the user.

{
    "title":"ApiEntityExternallySourcedUser",
    "required":[
        "email",
        "firstName",
        "lastName"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "email":{
            "maxLength":320,
            "type":"string",
            "description":"The email address of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userType":{
            "type":"string",
            "description":"The type of the user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "USER",
                "COMPANY_RESTRICTED",
                "APPLICATION_ADMIN",
                "IDEA_SUBMITTER"
            ]
        },
        "userLocale":{
            "type":"string",
            "description":"The language code for a user. <ol><li><code>pt_BR</code> - Brazilian Portuguese</li><li><code>nl</code> - Dutch</li><li><code>en</code> - English</li><li><code>fr</code> - French</li><li><code>de</code> - German</li><li><code>it</code> - Italian</li><li><code>ja</code> - Japanese</li><li><code>ko</code> - Korean</li><li><code>ru</code> - Russian</li><li><code>zh_CN</code> - Simplified Chinese</li><li><code>es</code> - Spanish</li><li><code>zh_TW</code> - Traditional Chinese</li></ol>",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "firstName":{
            "maxLength":100,
            "type":"string",
            "description":"The first name of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "mobile":{
            "maxLength":100,
            "type":"string",
            "description":"The mobile phone number of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "lastName":{
            "maxLength":100,
            "type":"string",
            "description":"The last name of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userId":{
            "type":"integer",
            "description":"The system-generated identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "title":{
            "maxLength":25,
            "type":"string",
            "description":"The title of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "phone":{
            "maxLength":100,
            "type":"string",
            "description":"The phone number of a user.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "status":{
            "maxLength":20,
            "type":"string",
            "description":"Determines the status of the user. When a user is inactive, they can no longer have access to login. Valid Values are ACTIVE and INACTIVE. ",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ACTIVE",
                "INACTIVE"
            ]
        },
        "userName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The identification used by a user to log in to the system.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userSettings":{
            "type":"array",
            "description":"A list of all user setting fields and values in the form of key value pairs.",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityApplicationUserSetting",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "ldapGuid":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The unique identifier in the external authentication system (LDAP or IDCS).",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "userProducts":{
            "type":"array",
            "description":"A list of all user product fields and values in the form of key value pairs. ",
            "exampleSetFlag":false,
            "items":{
                "$ref":"#/components/schemas/ApiEntityUserProduct",
                "exampleSetFlag":false
            },
            "types":[
                "array"
            ]
        },
        "lastLogInTime":{
            "type":"string",
            "description":"The date and time the user last logged into the application.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "restrictedUser":{
            "type":"boolean",
            "description":"Indicates that the user can only access records associated with the assigned company.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "companyId":{
            "type":"integer",
            "description":"The company the user is associated with.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : userProducts

Type: array

A list of all user product fields and values in the form of key value pairs.

Show Source

• Array of: object ApiEntityUserProduct
  Title: ApiEntityUserProduct

{
    "type":"array",
    "description":"A list of all user product fields and values in the form of key value pairs. ",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityUserProduct",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : userSettings

Type: array

A list of all user setting fields and values in the form of key value pairs.

Show Source

• Array of: object ApiEntityApplicationUserSetting
  Title: ApiEntityApplicationUserSetting

{
    "type":"array",
    "description":"A list of all user setting fields and values in the form of key value pairs.",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityApplicationUserSetting",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityUserProduct

Type: object

Title: ApiEntityUserProduct

Show Source

• applicationUserId: integer (int64)
  The system-generated unique identifier of a user.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• productId: integer (int64)
  The system-generated unique identifier of a license.
• productName: string
  Allowed Values: [ "IDEA", "PORTFOLIO", "PROGRESS", "SCHEDULE", "TASKS" ]

  The name of the license.
• updateDate: string (date-time)
  Date when the record was last updated.
• userProductId: integer (int64)
  The system-generated identifier for the user product.

{
    "title":"ApiEntityUserProduct",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "productId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a license.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "userProductId":{
            "type":"integer",
            "description":"The system-generated identifier for the user product.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "applicationUserId":{
            "type":"integer",
            "description":"The system-generated unique identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "productName":{
            "type":"string",
            "description":"The name of the license.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "IDEA",
                "PORTFOLIO",
                "PROGRESS",
                "SCHEDULE",
                "TASKS"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ApiEntityApplicationUserSetting

Type: object

Title: ApiEntityApplicationUserSetting

Show Source

• applicationUserId: integer (int64)
  The system-generated identifier of a user.
• applicationUserSettingId: integer (int64)
  The unique identifier of a user's settings.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• namespace: string
  Minimum Length: 1

  Maximum Length: 255

  The namespace to which a user is assigned.
• settingName: string
  Allowed Values: [ "ActivitiesViewSettings", "ActivityNetworkSettings", "ReportsSummaryGridViewConfig", "DecimalPlaces", "NumberDecimalPlaces", "CurrencySymbol", "FourDigitYear", "LeadingZeros", "MonthName", "Separator", "DateFormat", "DigitGroupingSeparator", "DecimalSeparator", "DigitGroupingAndDecimalSymbols", "DigitGroupingStyle", "CurrencyNegativeFormat", "CurrencyPositiveFormat", "TabOrder", "AppVisibilityAndOrder", "ProjectCodesViewConfig", "ProfileImage", "ReportColWidth", "ReportScheduleColWidth", "ScheduleColWidth", "WorkspaceAndProjectDisplayFormat", "AnnouncementsLastReadTime", "LocationsViewConfig", "workflowTasksPrefs", "WorkflowViewLogViewConfig", "monitorWorkflowsPrefs", "startWorkflowsPrefs", "workflowDesignsPrefs", "workflowConfigsPrefs", "monitorWorkflowTasksPrefs", "formTemplatesPrefs", "formPreviewPrefs", "userDashboardPref", "SearchAll", "SearchWorkspaces", "SearchProjects", "SearchScopeItems", "SearchProjectCodes", "SearchGenericPortfolios", "SearchActivities", "SearchDocuments", "SearchUsers", "SearchRisks", "SearchIdeas", "SearchPrograms", "NumberResultsPerSearchResultsPage", "SpatialSearchDefaultUnits", "SpatialSearchDefaultDistance", "SpatialSearchAllProjectsKeywords", "TimeFormat", "DisplayTime", "StatusUpdateActivitySortOrder", "StatusUpdateActivitySortField", "StatusUpdateProjectFilter", "StatusUpdateProjectFilterArray", "StatusUpdateTaskStatusFilter", "StatusUpdateTimeframeFilter", "StatusUpdateWBSFilter", "StatusUpdateFromDateFilter", "StatusUpdateToDateFilter", "ScheduleCheckBeiTarget", "SmLayoutLatestView", "UserAppliedFilterIdList", "ShowMinutes", "DataDateInPageBanners", "ActualDateIndicator", "ConstraintDateIndicator", "ResourceAnalysisDataView", "ResourceAssignmentDataView", "DisplayUnits", "UnitsSubUnits", "UnitsLabel", "UnitsPerTimeFormat", "DisplayDuration", "DurationSubUnits", "DurationLabel", "WhenAssigningResourceToExistingActivity", "WhenResourceAndRoleShareActivityAssignment", "UnitsDecimalPlaces", "UnitsNumberDecimalPlaces", "DurationDecimalPlaces", "DurationNumberDecimalPlaces", "ImportClobberOptions", "HomeRecentsVisible", "UserFirstName", "UserLastName", "UserTitle", "UserLocale", "UserAlternateEmail", "UserPhoneNumber", "UserMobileNumber", "UserFaxNumber", "UserDisplayDensity", "UserTimeZone", "OnboardedForVersion", "WorkPlanGettingStartedShown", "CookiesAcknowledged", "PlaAccepted", "LastSearchIndexRequest", "displayScheduleLog", "LastAccessedWorkPackageId", "LastSearchIndexCompleted", "ExperimentalEnhancedPrint", "ExperimentalColumnMenu", "AutoSaveNamedViews" ]

  The name of a user setting.
• settingValue: string
  Minimum Length: 1

  Maximum Length: 4000

  The value of a user setting.
• updateDate: string (date-time)
  Date when the record was last updated.

{
    "title":"ApiEntityApplicationUserSetting",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUserSettingId":{
            "type":"integer",
            "description":"The unique identifier of a user's settings.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "namespace":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The namespace to which a user is assigned.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "applicationUserId":{
            "type":"integer",
            "description":"The system-generated identifier of a user.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "settingName":{
            "type":"string",
            "description":"The name of a user setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ActivitiesViewSettings",
                "ActivityNetworkSettings",
                "ReportsSummaryGridViewConfig",
                "DecimalPlaces",
                "NumberDecimalPlaces",
                "CurrencySymbol",
                "FourDigitYear",
                "LeadingZeros",
                "MonthName",
                "Separator",
                "DateFormat",
                "DigitGroupingSeparator",
                "DecimalSeparator",
                "DigitGroupingAndDecimalSymbols",
                "DigitGroupingStyle",
                "CurrencyNegativeFormat",
                "CurrencyPositiveFormat",
                "TabOrder",
                "AppVisibilityAndOrder",
                "ProjectCodesViewConfig",
                "ProfileImage",
                "ReportColWidth",
                "ReportScheduleColWidth",
                "ScheduleColWidth",
                "WorkspaceAndProjectDisplayFormat",
                "AnnouncementsLastReadTime",
                "LocationsViewConfig",
                "workflowTasksPrefs",
                "WorkflowViewLogViewConfig",
                "monitorWorkflowsPrefs",
                "startWorkflowsPrefs",
                "workflowDesignsPrefs",
                "workflowConfigsPrefs",
                "monitorWorkflowTasksPrefs",
                "formTemplatesPrefs",
                "formPreviewPrefs",
                "userDashboardPref",
                "SearchAll",
                "SearchWorkspaces",
                "SearchProjects",
                "SearchScopeItems",
                "SearchProjectCodes",
                "SearchGenericPortfolios",
                "SearchActivities",
                "SearchDocuments",
                "SearchUsers",
                "SearchRisks",
                "SearchIdeas",
                "SearchPrograms",
                "NumberResultsPerSearchResultsPage",
                "SpatialSearchDefaultUnits",
                "SpatialSearchDefaultDistance",
                "SpatialSearchAllProjectsKeywords",
                "TimeFormat",
                "DisplayTime",
                "StatusUpdateActivitySortOrder",
                "StatusUpdateActivitySortField",
                "StatusUpdateProjectFilter",
                "StatusUpdateProjectFilterArray",
                "StatusUpdateTaskStatusFilter",
                "StatusUpdateTimeframeFilter",
                "StatusUpdateWBSFilter",
                "StatusUpdateFromDateFilter",
                "StatusUpdateToDateFilter",
                "ScheduleCheckBeiTarget",
                "SmLayoutLatestView",
                "UserAppliedFilterIdList",
                "ShowMinutes",
                "DataDateInPageBanners",
                "ActualDateIndicator",
                "ConstraintDateIndicator",
                "ResourceAnalysisDataView",
                "ResourceAssignmentDataView",
                "DisplayUnits",
                "UnitsSubUnits",
                "UnitsLabel",
                "UnitsPerTimeFormat",
                "DisplayDuration",
                "DurationSubUnits",
                "DurationLabel",
                "WhenAssigningResourceToExistingActivity",
                "WhenResourceAndRoleShareActivityAssignment",
                "UnitsDecimalPlaces",
                "UnitsNumberDecimalPlaces",
                "DurationDecimalPlaces",
                "DurationNumberDecimalPlaces",
                "ImportClobberOptions",
                "HomeRecentsVisible",
                "UserFirstName",
                "UserLastName",
                "UserTitle",
                "UserLocale",
                "UserAlternateEmail",
                "UserPhoneNumber",
                "UserMobileNumber",
                "UserFaxNumber",
                "UserDisplayDensity",
                "UserTimeZone",
                "OnboardedForVersion",
                "WorkPlanGettingStartedShown",
                "CookiesAcknowledged",
                "PlaAccepted",
                "LastSearchIndexRequest",
                "displayScheduleLog",
                "LastAccessedWorkPackageId",
                "LastSearchIndexCompleted",
                "ExperimentalEnhancedPrint",
                "ExperimentalColumnMenu",
                "AutoSaveNamedViews"
            ]
        },
        "settingValue":{
            "maxLength":4000,
            "minLength":1,
            "type":"string",
            "description":"The value of a user setting.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Batch Create or Update Resources by Assigning Hierarchical Code Values Using Codes Batch Create or Update Resources Using Parent ID Batch Create or Update Resources by Assigning Code Values Using Codes Batch Create or Update Resources Using Codes

Back to Top

Response

Supported Media Types

• application/json

207 Response

The object was successfully integrated.

Body ()

Root Schema : List<ApiEntityERPSyncApiResponse>

Type: array

Title: List<ApiEntityERPSyncApiResponse>

Show Source

• Array of: object ApiEntityERPSyncApiResponse
  Title: ApiEntityERPSyncApiResponse

{
    "title":"List<ApiEntityERPSyncApiResponse>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityERPSyncApiResponse",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityERPSyncApiResponse

Type: object

Title: ApiEntityERPSyncApiResponse

Show Source

• identifier: object identifier
  The unique identifier of the supported object returned based on the user input.
  This field can return any of the following entities determined based on the object for which the API call is invoked.
  Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• message: string
  Message is populated based on result of the operation.
  Success - Message will not be populated. Please refer the statusCode.
  Failure - Error message or reason for operation failure is populated.
  Warning - warning message is populated.
  The field is non-persistable and thus maximum length is not applicable.
• primaryKeyName: string
  The primary key field name associated with the integrated object.
  The field is non-persistable and thus maximum length is not applicable.
• primaryKeyValue: integer (int64)
  The unique identifier for the integrated object.
• sourceId: string
  Maximum Length: 255

  The unique identifier of the object in an external source.
• statusCode: integer (int32)
  The response code representing the state of the API operation.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityERPSyncApiResponse",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "statusCode":{
            "type":"integer",
            "description":"The response code representing the state of the API operation.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "primaryKeyName":{
            "type":"string",
            "description":"The primary key field name associated with the integrated object.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "primaryKeyValue":{
            "type":"integer",
            "description":"The unique identifier for the integrated object.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier of the object in an external source.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "message":{
            "type":"string",
            "description":"Message is populated based on result of the operation.<br>Success - Message will not be populated. Please refer the statusCode.<br>Failure - Error message or reason for operation failure is populated.<br>Warning - warning message is populated.<br />The field is non-persistable and thus maximum length is not applicable.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "identifier":{
            "type":"object",
            "description":"The unique identifier of the supported object returned based on the user input. <br />This field can return any of the following entities determined based on the object for which the API call is invoked. <br /><b>Example :</b> ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.",
            "exampleSetFlag":false,
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ProjectIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/CBSSheetCodeIdentifier",
                    "exampleSetFlag":false
                },
                {
                    "$ref":"#/components/schemas/ResourceIdentifier",
                    "exampleSetFlag":false
                }
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : identifier

Type: object

The unique identifier of the supported object returned based on the user input.
This field can return any of the following entities determined based on the object for which the API call is invoked.
Example : ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.

Match One Schema

Show Source

• object ProjectIdentifier
  Title: ProjectIdentifier
• object CBSSheetCodeIdentifier
  Title: CBSSheetCodeIdentifier
• object ResourceIdentifier
  Title: ResourceIdentifier

{
    "type":"object",
    "description":"The unique identifier of the supported object returned based on the user input. <br />This field can return any of the following entities determined based on the object for which the API call is invoked. <br /><b>Example :</b> ProjectIdentifier is returned when Batch Integrate Projects with an External Data Source API is invoked.",
    "exampleSetFlag":false,
    "oneOf":[
        {
            "$ref":"#/components/schemas/ProjectIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/CBSSheetCodeIdentifier",
            "exampleSetFlag":false
        },
        {
            "$ref":"#/components/schemas/ResourceIdentifier",
            "exampleSetFlag":false
        }
    ]
}

Nested Schema : ProjectIdentifier

Type: object

Title: ProjectIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ProjectIdentifier",
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : CBSSheetCodeIdentifier

Type: object

Title: CBSSheetCodeIdentifier

Show Source

• cbsCode: string
  Maximum Length: 60

  The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.
• cbsSheetCodeId: integer (int64)
  The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.
• costSheetId: integer (int64)
  The unique identifier of a cost sheet.
• parentId: integer (int64)
  The system-generated identifier of a parent cost item in a cost sheet.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"CBSSheetCodeIdentifier",
    "type":"object",
    "properties":{
        "costSheetId":{
            "type":"integer",
            "description":"The unique identifier of a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "parentId":{
            "type":"integer",
            "description":"The system-generated identifier of a parent cost item in a cost sheet.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsSheetCodeId":{
            "type":"integer",
            "description":"The ID of the cost breakdown structure code. The CBS code is a code that is concatenated with its parent and child according to the segment definition.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "cbsCode":{
            "maxLength":60,
            "type":"string",
            "description":"The cost breakdown structure code is a code that is concatenated with its parent and child according to the segment definition.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

Nested Schema : ResourceIdentifier

Type: object

Title: ResourceIdentifier

Show Source

• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• resourceClass: string
  Allowed Values: [ "RESOURCE", "ROLE" ]

  The class identifies the item as a resource or a role.
• resourceCode: string
  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId: integer (int64)
  The unique identifier for the resource or role.
• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ResourceIdentifier",
    "type":"object",
    "properties":{
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource or role.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "resourceClass":{
            "type":"string",
            "description":"The class identifies the item as a resource or a role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "RESOURCE",
                "ROLE"
            ]
        },
        "resourceCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":60,
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "workspaceCode":{
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid Input.

Back to Top