Jump to

• Request
• Response

Get resources that match the specified role criteria.

post

/fscmRestApi/resources/11.13.18.05/projectResourceRequestMatches/action/getProjectResourceMatchesByRole

Get resources that match a specified project role and are available for the defined duration.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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.

Supported Media Types

• application/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• billRateMax: string
  Maximum value for the bill rate filter.
• billRateMin: string
  Minimum value for the bill rate filter.
• buId: number
  Unique identifier for the Business Unit filter.
• costRateMax: string
  Maximum value for the cost rate filter.
• costRateMin: string
  Minimum value for the cost rate filter.
• departmentId: number
  Unique identifier for the Department filter.
• finishDate: string (date)
  Finish date of the project resource???s assignment on the project.
• jobId: number
  Unique identifier for the job filter.
• limit: number
  Limits the number of rows returned in the response.
• locationId: number
  Unique identifier for the Location filter.
• poolIds: array poolIds
  List of unique identifiers for the resource pools filter.
• projectId: number
  Unique identifier for the project.
• projectRoleId: number
  Unique identifier for the project role.
• startDate: string (date)
  Start date of the project resource???s assignment on the project.
• useProjCalFlag: string
  Indicates whether the project resource uses the project calendar. Valid values are Y, N, X, and W.

{
    "type":"object",
    "properties":{
        "buId":{
            "type":"number",
            "description":"Unique identifier for the Business Unit filter.",
            "nullable":true
        },
        "costRateMin":{
            "type":"string",
            "description":"Minimum value for the cost rate filter.",
            "nullable":true
        },
        "departmentId":{
            "type":"number",
            "description":"Unique identifier for the Department filter.",
            "nullable":true
        },
        "useProjCalFlag":{
            "type":"string",
            "description":"Indicates whether the project resource uses the project calendar. Valid values are Y, N, X, and W.",
            "nullable":true
        },
        "billRateMin":{
            "type":"string",
            "description":"Minimum value for the bill rate filter.",
            "nullable":true
        },
        "projectRoleId":{
            "type":"number",
            "description":"Unique identifier for the project role.",
            "nullable":true
        },
        "poolIds":{
            "type":"array",
            "description":"List of unique identifiers for the resource pools filter.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "costRateMax":{
            "type":"string",
            "description":"Maximum value for the cost rate filter.",
            "nullable":true
        },
        "jobId":{
            "type":"number",
            "description":"Unique identifier for the job filter.",
            "nullable":true
        },
        "locationId":{
            "type":"number",
            "description":"Unique identifier for the Location filter.",
            "nullable":true
        },
        "limit":{
            "type":"number",
            "description":"Limits the number of rows returned in the response.",
            "nullable":true
        },
        "finishDate":{
            "type":"string",
            "description":"Finish date of the project resource???s assignment on the project.",
            "format":"date",
            "nullable":true
        },
        "projectId":{
            "type":"number",
            "description":"Unique identifier for the project.",
            "nullable":true
        },
        "billRateMax":{
            "type":"string",
            "description":"Maximum value for the bill rate filter.",
            "nullable":true
        },
        "startDate":{
            "type":"string",
            "description":"Start date of the project resource???s assignment on the project.",
            "format":"date",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : poolIds

Type: array

List of unique identifiers for the resource pools filter.

Show Source

• Array of: number

{
    "type":"array",
    "description":"List of unique identifiers for the resource pools filter.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): array result
  This custom action returns a list of resources that match the specified role.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"array",
            "description":"This custom action returns a list of resources that match the specified role.",
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: array

This custom action returns a list of resources that match the specified role.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"This custom action returns a list of resources that match the specified role.",
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top