Estimate Scenario Resources

Estimate Scenario Resources represent placeholders for unnamed resources in a specific estimate scenario.

Operations

Fetching a list of Estimate Scenario Resources

Request

This endpoint provides a list of all scenario resources associated with the specified estimate scenario.

This endpoint returns structured Estimate Scenario Resource objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the estimate_scenario_resources top-level JSON key. Please see our Response Format section for more information.

Query

estimate_scenario_idinteger, (int32)required

Required to retrieve the resources for a specified estimate scenario.

created_afterstring, (date-time)

Filter for records created after a specified datetime. The datetime must be in ISO 8601 format.

created_beforestring, (date-time)

Filter for records created before a specified datetime. The datetime must be in ISO 8601 format.

external_reference_external_messagestring

Filter the objects based on the external message of their associated external references. This is an exact match.

external_reference_external_statusstring

Filter by the status of the external object in the external system.

external_reference_service_modelstring

Filter by the type of the external object this external reference belongs to.

external_reference_service_model_refinteger, (int32)

Filter by the id of the external object this external reference belongs to.

external_reference_service_model_refsstring

Filter for objects that correlate to the specified external object IDs. Provide a comma-separated list of up to 200 external IDs.

external_reference_service_namestring

Filter by the name of the provider for integration.

external_reference_statusstring

Filter by the status of the integration, this can be successful or fail.

has_external_referencesboolean

Filter by whether or not the object has external references.

includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

allocation (EstimateScenarioResourceAllocation) - The Estimate Scenario Resource Allocation of the Estimate Scenario Resource.
external_references (ExternalReference) - Includes references to external integrations for this object.
geography (Geography) - The Geography of the Estimate Scenario Resource.
organization_membership (OrganizationMembership) - Retrieves the organization memberships for the resource. The response will include organization_membership_id, which references the data in the organization_memberships top-level key.
role (Role)
user (User).

onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

orderstring

Supply order with the name of a valid sort field for the endpoint and a direction.

Valid values: alphabetically:asc, alphabetically:desc, created_at:asc, created_at:desc, updated_at:asc, and updated_at:desc.

Default:"updated_at:desc"

pageinteger, (int32)

Default:1

per_pageinteger, (int32), <= 200

Default:20

updated_afterstring, (date-time)

Filter for records updated after a specified datetime. The datetime must be in ISO 8601 format.

updated_beforestring, (date-time)

Filter for records updated before a specified datetime. The datetime must be in ISO 8601 format.

without_external_reference_service_namestring

Exclude by the existence of an external reference with the specified service name.

GET

/estimate_scenario_resources

curl -i -X GET \
  'https://api.mavenlink.com/api/v1/estimate_scenario_resources?estimate_scenario_id=0&created_after=2019-08-24T14%3A15%3A22Z&created_before=2019-08-24T14%3A15%3A22Z&external_reference_external_message=string&external_reference_external_status=string&external_reference_service_model=string&external_reference_service_model_ref=0&external_reference_service_model_refs=string&external_reference_service_name=string&external_reference_status=string&has_external_references=true&include=string&only=string&order=updated_at%3Adesc&page=1&per_page=20&updated_after=2019-08-24T14%3A15%3A22Z&updated_before=2019-08-24T14%3A15%3A22Z&without_external_reference_service_name=string'

Responses

A list of Estimate Scenario Resources have been retrieved.

Bodyapplication/json

countinteger, (int32)

metaobject

resultsArray of objects

estimate_scenario_resourcesobject

external_referencesobject

usersobject

rolesobject

organization_membershipsobject

estimate_scenario_resource_allocationsobject

organizationsobject

Response

{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "estimate_scenario_resources": {
    "property1": {
      "allocation_id": "string",
      "bill_rate": 0,
      "cost_rate": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "display_label": "string",
      "estimate_scenario_id": 0,
      "external_reference_ids": [
        "string"
      ],
      "geography_id": "string",
      "label": "string",
      "organization_membership_id": "string",
      "role_id": "string",
      "role_name": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    },
    "property2": {
      "allocation_id": "string",
      "bill_rate": 0,
      "cost_rate": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "display_label": "string",
      "estimate_scenario_id": 0,
      "external_reference_ids": [
        "string"
      ],
      "geography_id": "string",
      "label": "string",
      "organization_membership_id": "string",
      "role_id": "string",
      "role_name": "string",
      "updated_at": "2019-08-24T14:15:22Z",
      "user_id": "string"
    }
  },
  "external_references": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "external_link": "string",
      "external_message": "string",
      "external_status": "string",
      "last_synced_at": "2019-08-24T14:15:22Z",
      "locked": true,
      "service_model": "string",
      "service_model_ref": "string",
      "service_name": "string",
      "status": "string",
      "subject_id": 0,
      "subject_ref": {
        "key": "string",
        "id": "string"
      },
      "subject_type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "users": {
    "property1": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    },
    "property2": {
      "abbreviated_timezone": "string",
      "account_membership_id": "string",
      "bio": "string",
      "city": "string",
      "classification": "string",
      "country": "string",
      "custom_field_value_ids": [
        "string"
      ],
      "email_address": "string",
      "external_reference_ids": [
        "string"
      ],
      "full_name": "string",
      "headline": "string",
      "last_site_activity": "2019-08-24T14:15:22Z",
      "manager_id": "string",
      "photo_path": "string",
      "role_id": "string",
      "skill_ids": [
        "string"
      ],
      "skill_membership_ids": [
        "string"
      ],
      "state": "string",
      "website": "string",
      "work_sample_ids": [
        "string"
      ]
    }
  },
  "roles": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "external_reference_ids": [
        "string"
      ],
      "name": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "organization_memberships": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "department_id": "string",
      "geography_id": "string",
      "member_id": "string",
      "member_type": "string",
      "primary": true,
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "department_id": "string",
      "geography_id": "string",
      "member_id": "string",
      "member_type": "string",
      "primary": true,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "estimate_scenario_resource_allocations": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "duration_days": 0,
      "percent_allocated": 0.1,
      "relative_start_day": 0,
      "resource_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "duration_days": 0,
      "percent_allocated": 0.1,
      "relative_start_day": 0,
      "resource_id": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "organizations": {
    "property1": {
      "ancestor_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "parent_id": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "ancestor_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "parent_id": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}