Jump to

• Request
• Response
• Examples

Get all enterprise project and task codes

get

/fscmRestApi/resources/11.13.18.05/enterpriseProjectAndTaskCodes

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  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 enterprise project or task code with the specified code ID.
    Finder Variables
    • CodeId; integer; The identifier of the enterprise project or task code.
• limit: integer
  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.
• links: string
  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
  
• offset: integer
  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.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  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
• q: string
  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:
  

  • CodeId; integer; Unique identifier of the enterprise code.
  • CodePurpose; string; Indicates if the enterprise code will be used for projects or for project tasks. Valid values are TASK, PROJECTS.
  • ColumnDescription; string; Description of the enterprise project or task code.
  • ColumnName; string; Label that will be externally visible for the enterprise project or task code.
  • CreatedBy; string; User who created the record.
  • CreationDate; string; Date when the record was created.
  • DataType; string; Type of the value of the enterprise project or task code. Valid values are LOV, NUMBER, TEXT.
  • DisableFlag; boolean; Indicates if the enterprise code is disabled. Value is true if it's disabled and value is false if the project or task code is enabled.
  • EnterpriseCode; string; Name of the enterprise code used to extend attributes of project or tasks.
  • EnterpriseCodeId; string; Identifier of the enterprise project code or enterprise task code.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdatedBy; string; The user who last updated the record.
• totalResults: boolean
  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

• Metadata-Context:
  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".
• REST-Framework-Version:
  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

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  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".
• REST-Framework-Version:
  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 : enterpriseProjectAndTaskCodes

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/enterpriseProjectAndTaskCodes-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object enterpriseProjectAndTaskCodes-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/enterpriseProjectAndTaskCodes-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : enterpriseProjectAndTaskCodes-item-response

Type: object

Show Source

• AcceptedValues: array Accepted Values
  Title: Accepted Values

  List of accepted values for an enterprise project code or task code.
• CodeId: integer
  Title: Code ID

  Read Only: true

  Unique identifier of the enterprise code.
• CodePurpose: string
  Title: Enterprise Code Purpose

  Read Only: true

  Indicates if the enterprise code will be used for projects or for project tasks. Valid values are TASK, PROJECTS.
• ColumnDescription: string
  Title: Column Description

  Read Only: true

  Maximum Length: 200

  Description of the enterprise project or task code.
• ColumnName: string
  Title: Column Name

  Read Only: true

  Maximum Length: 80

  Label that will be externally visible for the enterprise project or task code.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• DataType: string
  Title: Data Type

  Read Only: true

  Maximum Length: 20

  Type of the value of the enterprise project or task code. Valid values are LOV, NUMBER, TEXT.
• DisableFlag: boolean
  Title: Disable Indicator

  Read Only: true

  Indicates if the enterprise code is disabled. Value is true if it's disabled and value is false if the project or task code is enabled.
• EnterpriseCode: string
  Title: Enterprise Code Name

  Read Only: true

  Maximum Length: 80

  Name of the enterprise code used to extend attributes of project or tasks.
• EnterpriseCodeId: string
  Title: Enterprise Code ID

  Read Only: true

  Identifier of the enterprise project code or enterprise task code.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ColumnDescription":{
            "title":"Column Description",
            "maxLength":"200",
            "type":"string",
            "description":"Description of the enterprise project or task code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CodePurpose":{
            "title":"Enterprise Code Purpose",
            "type":"string",
            "description":"Indicates if the enterprise code will be used for projects or for project tasks. Valid values are TASK, PROJECTS.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "ObjectType"
                ]
            },
            "x-queryable":true
        },
        "ColumnName":{
            "title":"Column Name",
            "maxLength":"80",
            "type":"string",
            "description":"Label that will be externally visible for the enterprise project or task code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptedValues":{
            "title":"Accepted Values",
            "type":"array",
            "description":"List of accepted values for an enterprise project code or task code.",
            "items":{
                "$ref":"#/components/schemas/enterpriseProjectAndTaskCodes-AcceptedValues-item-response"
            }
        },
        "CodeId":{
            "title":"Code ID",
            "type":"integer",
            "description":"Unique identifier of the enterprise code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DataType":{
            "title":"Data Type",
            "maxLength":"20",
            "type":"string",
            "description":"Type of the value of the enterprise project or task code. Valid values are LOV, NUMBER, TEXT.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisableFlag":{
            "title":"Disable Indicator",
            "type":"boolean",
            "description":"Indicates if the enterprise code is disabled. Value is true if it's disabled and value is false if the project or task code is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "EnabledFlag"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EnterpriseCodeId":{
            "title":"Enterprise Code ID",
            "type":"string",
            "description":"Identifier of the enterprise project code or enterprise task code.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "CodeName",
                    "CodePurpose",
                    "DataType"
                ]
            },
            "x-queryable":true
        },
        "EnterpriseCode":{
            "title":"Enterprise Code Name",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the enterprise code used to extend attributes of project or tasks.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Accepted Values

Type: array

Title: Accepted Values

List of accepted values for an enterprise project code or task code.

Show Source

• Array of: object enterpriseProjectAndTaskCodes-AcceptedValues-item-response

{
    "title":"Accepted Values",
    "type":"array",
    "description":"List of accepted values for an enterprise project code or task code.",
    "items":{
        "$ref":"#/components/schemas/enterpriseProjectAndTaskCodes-AcceptedValues-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : enterpriseProjectAndTaskCodes-AcceptedValues-item-response

Type: object

Show Source

• AcceptedValue: string
  Title: Accepted Value

  Read Only: true

  Maximum Length: 80

  An accepted value of the enterprise project or task code.
• AcceptedValueDisableFlag: boolean
  Title: Accepted Value Disable Indicator

  Read Only: true

  Indicates if the enterprise project or task code accepted value is disabled. Value is true if it's disabled and value is false if the enterprise code accepted value is enabled.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  User who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date when the record was created.
• DisplaySequence: number
  Title: Accepted Value Display Sequence

  Read Only: true

  The order in which the value is displayed within the list of valid accepted values of the enterprise project or task code.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ValueId: integer (int64)
  Title: Accepted Value ID

  Read Only: true

  Identifier of an accepted value for the enterprise project or task code of type list of values.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptedValueDisableFlag":{
            "title":"Accepted Value Disable Indicator",
            "type":"boolean",
            "description":"Indicates if the enterprise project or task code accepted value is disabled. Value is true if it's disabled and value is false if the enterprise code accepted value is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "EnabledFlag"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"User who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptedValue":{
            "title":"Accepted Value",
            "maxLength":"80",
            "type":"string",
            "description":"An accepted value of the enterprise project or task code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "title":"Accepted Value Display Sequence",
            "type":"number",
            "description":"The order in which the value is displayed within the list of valid accepted values of the enterprise project or task code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ValueId":{
            "title":"Accepted Value ID",
            "type":"integer",
            "description":"Identifier of an accepted value for the enterprise project or task code of type list of values.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to get all enterprise project and task codes 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/enterpriseProjectAndTaskCodes

Response Body Example

The following shows an example of the response body in JSON format of all project templates.

{
  "items": [
    {
      "CodeId": 300100026790124,
      "EnterpriseCode": "List of Values 01",
      "EnterpriseCodeId": "TaskCode01Id",
      "DataType": "LOV",
      "ColumnName": "PJT_TASK_CODE_LOV",
      "ColumnDescription": "Task Code: PJT_TASK_CODE_LOV",
      "DisableFlag": false,
      "CodePurpose": "TASK",
      "CreatedBy": "Mark.Taylor",
      "LastUpdatedBy": "Mark.Taylor",
      "LastUpdateDate": "2013-08-21T23:48:20+00:00",
      "CreationDate": "2013-08-21T23:45:21+00:00",
      "links": [
        {
          "rel": "self",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/enterpriseProjectAndTaskCodes/300100026790124",
          "name": "enterpriseProjectAndTaskCodes",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
          }
        },
        {
          "rel": "canonical",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/enterpriseProjectAndTaskCodes/300100026790124",
          "name": "enterpriseProjectAndTaskCodes",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/enterpriseProjectAndTaskCodes/300100026790124/child/AcceptedValues",
          "name": "AcceptedValues",
          "kind": "collection"
        }
      ]
    }
...
]
}

Back to Top