Jump to

• Request
• Response

Create Resource Demand from Schedule

post

/api/restapi/action/resourceDemand/fetchAssignment

Send a request to this endpoint to schedule a demand data to fetch from resource assignments.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityDemandSchedule

Type: object

Title: ApiEntityDemandSchedule

Show Source

• deleteUnmatchedRole: boolean
  delete unmatched role.
• keepExistingDemands: boolean
  Keep existing demands.
• projectCode(required): string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• workspaceCode(required): string
  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId: integer (int64)
  The unique identifier of a workspace.

{
    "title":"ApiEntityDemandSchedule",
    "required":[
        "projectCode",
        "workspaceCode"
    ],
    "type":"object",
    "properties":{
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier of a workspace.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "keepExistingDemands":{
            "type":"boolean",
            "description":"Keep existing demands.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "deleteUnmatchedRole":{
            "type":"boolean",
            "description":"delete unmatched role. ",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "exampleSetFlag":false
}

Examples

Select an example Create Resource Demand from Schedule

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : ApiEntityScheduleJob

Type: object

Title: ApiEntityScheduleJob

Show Source

• jobId: integer (int64)
  The unique identifier for the background service.
• jobKey: integer (int64)
  The unique identifier for a job.
• jobStatus: string
  Allowed Values: [ "NEW", "QUEUED", "RUNNING", "DELEGATED", "ON_HOLD", "REJECTED", "COMPLETED", "COMPLETED_WITH_ERRORS", "FAILED", "NOOP", "COMPLETED_WITH_WARNINGS", "RETRIED" ]

  The status of the background service.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.

{
    "title":"ApiEntityScheduleJob",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "jobKey":{
            "type":"integer",
            "description":"The unique identifier for a job.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobId":{
            "type":"integer",
            "description":"The unique identifier for the background service.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "jobStatus":{
            "type":"string",
            "description":"The status of the background service.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "NEW",
                "QUEUED",
                "RUNNING",
                "DELEGATED",
                "ON_HOLD",
                "REJECTED",
                "COMPLETED",
                "COMPLETED_WITH_ERRORS",
                "FAILED",
                "NOOP",
                "COMPLETED_WITH_WARNINGS",
                "RETRIED"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input for the Action service.

404 Response

The requested object does not exist, or you do not have access to it.

Back to Top