Get all deliverable and work item types

get

/fscmRestApi/resources/11.13.18.05/deliverableTypesLOV

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables

    • PrimaryKey Finds the deliverable or work item type with the specified primary key.
      Finder Variables
      • DeliverableTypeId; integer; Unique identifier of the deliverable or work item type.
    • findActiveDeliverableTypes Finds the deliverable types that are enabled and where the deliverable type from and to date range overlaps with the current date.
      Finder Variables
      • Bind_currentDate; string; The current date of the web service request to get a list of deliverable types.
    • findDeliverableTypes Finds all deliverable types.
      Finder Variables
      • findWorkItemTypes Finds all work item types.
        Finder Variables
      • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
      • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

        Example:
        self,canonical
      • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
      • The resource item payload will be filtered in order to contain only data (no links section, for example).
      • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
      • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

        Format: ?q=expression1;expression2

        You can use these queryable attributes to filter this collection resource using the q query parameter:
        • DeliverableTypeClass; string; The code representing the classification of the deliverable or work item type. Values include DOCUMENT, GENERAL, PLM_CHANGE, PLM_CONCEPT, PLM_ITEM, PLM_PROPOSAL, PLM_RQMT, and PON_NEGOTIATION.
        • DeliverableTypeId; integer; Unique identifier of the deliverable or work item type.
        • Description; string; Text to describe the deliverable or work item type.
        • DisabledFlag; boolean; Indicates if the deliverable type should no longer be used. True indicates the deliverable type is disabled and should no longer be used. False indicates it's not disabled.
        • FromDate; string; Date when the deliverable type is available to use for creating and editing deliverables.
        • Name; string; Name of the deliverable or work item type.
        • ToDate; string; Date when the deliverable type should no longer be used for creating and updating deliverables.
      • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
      Header Parameters
      • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
      • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

      There's no request body for this operation.

      Back to Top

      Response

      Supported Media Types

      Default Response

      The following table describes the default response for this task.
      Headers
      • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
      • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
      Body ()
      Root Schema : deliverableTypesLOV
      Type: object
      Show Source
      Nested Schema : Items
      Type: array
      Title: Items
      The items in the collection.
      Show Source
      Nested Schema : deliverableTypesLOV-item-response
      Type: object
      Show Source
      • Read Only: true
        Maximum Length: 30
        The code representing the classification of the deliverable or work item type. Values include DOCUMENT, GENERAL, PLM_CHANGE, PLM_CONCEPT, PLM_ITEM, PLM_PROPOSAL, PLM_RQMT, and PON_NEGOTIATION.
      • Read Only: true
        Unique identifier of the deliverable or work item type.
      • Read Only: true
        Maximum Length: 150
        Text to describe the deliverable or work item type.
      • Read Only: true
        Maximum Length: 1
        Indicates if the deliverable type should no longer be used. True indicates the deliverable type is disabled and should no longer be used. False indicates it's not disabled.
      • Read Only: true
        Date when the deliverable type is available to use for creating and editing deliverables.
      • Links
      • Read Only: true
        Maximum Length: 80
        Name of the deliverable or work item type.
      • Read Only: true
        Date when the deliverable type should no longer be used for creating and updating deliverables.
      Back to Top

      Examples

      The following example shows how to get all deliverable types by submitting a GET request on the REST resource using cURL.

      curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/deliverableTypesLOV

      Response Body Example

      The following shows an example of the response body in JSON format of the award funding sources.

      {
        "items": [
          {
            "DeliverableTypeId": 300100046911702,
            "Description": "CDRM data to test deliverable type",
            "DisabledFlag": false,
            "FromDate": "2012-01-01",
            "Name": "CDRM Deliverable Type",
            "ToDate": null,
            "links": [
              {
                "rel": "self",
                "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/deliverableTypesLOV/300100046911702",
                "name": "deliverableTypesLOV",
                "kind": "item"
              },
              {
                "rel": "canonical",
                "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/deliverableTypesLOV/300100046911702",
                "name": "deliverableTypesLOV",
                "kind": "item"
              }
            ]
          },
          {
            "DeliverableTypeId": 1,
            "Description": "General Document Deliverable",
            "DisabledFlag": false,
            "FromDate": "2009-02-20",
            "Name": "General",
            "ToDate": null,
            "links": [
              {
                "rel": "self",
                "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/deliverableTypesLOV/1",
                "name": "deliverableTypesLOV",
                "kind": "item"
              },
              {
                "rel": "canonical",
                "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/deliverableTypesLOV/1",
                "name": "deliverableTypesLOV",
                "kind": "item"
              }
            ]
          },
      	...
      	]
      }
      Back to Top