Jump to

• Request
• Response

StorePeriodPerformance

post

/job/storePeriodPerformance

Asynchronously stores period performance for a single project.

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of project objects for recalculateAssignmentCosts service

Root Schema : List<StorePeriodPerformance>

Type: array

Title: List<StorePeriodPerformance>

Show Source

• Array of: object StorePeriodPerformance

{
    "title":"List<StorePeriodPerformance>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/StorePeriodPerformance"
    }
}

Nested Schema : StorePeriodPerformance

Type: object

Show Source

• financialPeriodObjectId: integer (int32)
• projectObjectId: array ProjectObjectId
• timeout: integer (int32)

{
    "type":"object",
    "properties":{
        "projectObjectId":{
            "type":"array",
            "xml":{
                "name":"ProjectObjectId"
            },
            "items":{
                "type":"integer",
                "format":"int32",
                "xml":{
                    "name":"ProjectObjectId"
                }
            }
        },
        "financialPeriodObjectId":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "name":"FinancialPeriodObjectId"
            }
        },
        "timeout":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "name":"Timeout"
            }
        }
    }
}

Nested Schema : ProjectObjectId

Type: array

Show Source

• Array of: integer(int32)

{
    "type":"array",
    "xml":{
        "name":"ProjectObjectId"
    },
    "items":{
        "type":"integer",
        "format":"int32",
        "xml":{
            "name":"ProjectObjectId"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

OK.

Body ()

Root Schema : CreateJobServiceResponse

Type: object

Title: CreateJobServiceResponse

CreateJobServiceResponse Entity

Show Source

• JobId: string
  The unique ID of the associated job.
• JobStatus: string
  Status of the job.

{
    "title":"CreateJobServiceResponse",
    "type":"object",
    "properties":{
        "JobId":{
            "type":"string",
            "description":"The unique ID of the associated job."
        },
        "JobStatus":{
            "type":"string",
            "description":"Status of the job."
        }
    },
    "description":"CreateJobServiceResponse Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top