openapi: 3.2.0 info: title: Workfront Planning Workspaces API description: "This is WF Planning Service API documentation. WF Planning Service is responsible for creating and managing new workspace, field, record, record type objects across the Workfront Planning application. \n* **API paths**:\n * Gateway URL: https://{customer-domain}.my.workfront.com\n * Base path for this API: /maestro/api\n * Example of a complete path for making a call: https://{customer-domain}.my.workfront.com/maestro/api/v1/records/{id}\n* **Required headers**:\n * All calls require the headers `Authorization`, `x-gw-ims-org-id`, and `x-api-key`. For more information on how to obtain these values, see the [authentication tutorial](/guides/gaining_access/)." servers: - url: https://{customer-domain}/maestro/api description: Workfront Planning Service Url basePath: /maestro/api tags: - name: Workspaces description: Workspace Controller paths: /v1/workspaces: get: tags: - Workspaces summary: Get All Workspaces description: Retrieve a list of all workspaces along with optional attributes. operationId: getWorkspaces parameters: - name: attributes in: query description: List of attributes to be included in the response required: false schema: type: array items: type: string default: - '*' example: ALL responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/WorkspaceListDto' /v1/workspaces/{id}: get: tags: - Workspaces summary: Get Workspace description: Retrieve a workspace by its ID along with optional attributes. operationId: getWorkspace parameters: - name: id in: path description: ID of the workspace to be retrieved required: true schema: type: string - name: attributes in: query description: List of attributes to be included in the response required: false schema: type: array items: type: string default: - '*' example: ALL responses: '200': description: OK content: '*/*': schema: $ref: '#/components/schemas/WorkspaceDto' components: schemas: FieldNumberOptionsDto: type: object properties: precision: type: integer format: int32 allowNegatives: type: boolean currency: type: string enum: - AED - AFN - ALL - AMD - AON - ARS - AUD - AZN - BAM - BBD - BDT - BGL - BHD - BIF - BND - BOB - BRL - BSD - BTN - BWP - BYN - BZD - CAD - CDF - CHF - CLP - CNY - COP - CRC - CUP - CVE - DJF - DKK - DOP - DZD - EGP - ERN - ETB - EUR - FJD - GBP - GEL - GHC - GMD - GNF - GTQ - GYD - HNL - HRK - HTG - HUF - IDR - ILS - INR - IQD - IRR - ISK - JMD - JOD - JPY - KES - KGS - KHR - KMF - KPW - KRW - KWD - KZT - LAK - LBP - LKR - LRD - LSL - LYD - MAD - MDL - MGA - MKD - MMK - MNT - MRU - MUR - MVR - MWK - MXN - MYR - MZM - NAD - NGN - NIO - NOK - NPR - NZD - OMR - PAB - PEN - PGK - PHP - PKR - PLN - PYG - QAR - RON - RSD - RUB - RWF - SAR - SBD - SCR - SDG - SEK - SGD - SLL - SOS - SRD - SSP - STN - SYP - SZL - THB - TJS - TMT - TND - TOP - TRY - TTD - TZS - UAH - UGS - USD - UYU - UZS - VEF - VND - VUV - WST - XAF - XCD - XOF - YER - ZAR - ZMK - ZWD FieldReferenceExternalOptionsDto: type: object properties: connectionName: type: string objectName: type: string connectionOptions: type: object additionalProperties: type: string WorkspaceListDto: type: object properties: workspaces: type: array items: $ref: '#/components/schemas/WorkspaceDto' permission: type: string enum: - manage - edit - view - none FieldFormulaOptionsDto: type: object properties: formula: type: string RecordTypeExternalOptionsDto: type: object properties: connectionName: type: string objectName: type: string fields: type: object additionalProperties: type: string RecordTypeSectionDto: type: object properties: name: type: string displayName: type: string recordTypeIds: type: array items: type: string FieldUserOptionsDto: type: object properties: multipleUsersAllowed: type: boolean FieldReferenceLookupFieldDto: type: object properties: fieldId: type: string rollup: type: string FieldDateOptionsDto: type: object properties: dateFormat: type: string enum: - locale - standard - friendly - european - iso timeFormat: type: string enum: - h12 - h24 FieldOptionDto: type: object properties: name: type: string displayName: type: string color: type: string RecordTypeDto: type: object properties: id: type: string createdBy: type: string createdAt: type: string updatedBy: type: string updatedAt: type: string customerId: type: string imsOrgId: type: string alias: type: string displayName: type: string permission: type: string enum: - manage - edit - view - none primaryFieldId: type: string icon: type: string description: type: string color: type: string fields: type: array items: $ref: '#/components/schemas/FieldDto' isExternal: type: boolean externalOptions: $ref: '#/components/schemas/RecordTypeExternalOptionsDto' FieldLookupOptionsDto: type: object properties: referenceFieldId: type: string rollup: type: string sourceField: $ref: '#/components/schemas/FieldDto' FieldReferenceOptionsDto: type: object properties: multiple: type: boolean recordTypeId: type: string isExternal: type: boolean externalOptions: $ref: '#/components/schemas/FieldReferenceExternalOptionsDto' filters: type: object additionalProperties: type: object lookupFields: type: array items: $ref: '#/components/schemas/FieldReferenceLookupFieldDto' WorkspaceDto: type: object properties: id: type: string createdBy: type: string createdAt: type: string updatedBy: type: string updatedAt: type: string customerId: type: string imsOrgId: type: string alias: type: string name: type: string description: type: string color: type: string permission: type: string enum: - manage - edit - view - none icon: type: string recordTypes: type: array items: $ref: '#/components/schemas/RecordTypeDto' recordTypeSections: type: array items: $ref: '#/components/schemas/RecordTypeSectionDto' FieldDto: type: object properties: id: type: string createdBy: type: string createdAt: type: string updatedBy: type: string updatedAt: type: string customerId: type: string imsOrgId: type: string alias: type: string displayName: type: string type: type: string linkedField: $ref: '#/components/schemas/FieldDto' description: type: string options: type: array items: $ref: '#/components/schemas/FieldOptionDto' dateOptions: $ref: '#/components/schemas/FieldDateOptionsDto' numberOptions: $ref: '#/components/schemas/FieldNumberOptionsDto' referenceOptions: $ref: '#/components/schemas/FieldReferenceOptionsDto' lookupOptions: $ref: '#/components/schemas/FieldLookupOptionsDto' formulaOptions: $ref: '#/components/schemas/FieldFormulaOptionsDto' userOptions: $ref: '#/components/schemas/FieldUserOptionsDto' hasError: type: boolean